AWSTransferAsync (AWS SDK for Java

All Superinterfaces:

AWSTransfer

All Known Implementing Classes:

AbstractAWSTransferAsync, AWSTransferAsyncClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSTransferAsync
extends AWSTransfer
```
Interface 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.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSTransferAsync instead.

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 interface com.amazonaws.services.transfer.AWSTransfer
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Future<CreateAccessResult>`	`createAccessAsync(CreateAccessRequest createAccessRequest)` 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 createAccessRequest, 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 createServerRequest)` Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.
`Future<CreateServerResult>`	`createServerAsync(CreateServerRequest createServerRequest, 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 createUserRequest)` Creates a user and associates them with an existing file transfer protocol-enabled server.
`Future<CreateUserResult>`	`createUserAsync(CreateUserRequest createUserRequest, AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)` Creates a user and associates them with an existing file transfer protocol-enabled server.
`Future<CreateWorkflowResult>`	`createWorkflowAsync(CreateWorkflowRequest createWorkflowRequest)` Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.
`Future<CreateWorkflowResult>`	`createWorkflowAsync(CreateWorkflowRequest createWorkflowRequest, 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 deleteAccessRequest)` Allows you to delete the access specified in the `ServerID` and `ExternalID` parameters.
`Future<DeleteAccessResult>`	`deleteAccessAsync(DeleteAccessRequest deleteAccessRequest, AsyncHandler<DeleteAccessRequest,DeleteAccessResult> asyncHandler)` Allows you to delete the access specified in the `ServerID` and `ExternalID` parameters.
`Future<DeleteServerResult>`	`deleteServerAsync(DeleteServerRequest deleteServerRequest)` Deletes the file transfer protocol-enabled server that you specify.
`Future<DeleteServerResult>`	`deleteServerAsync(DeleteServerRequest deleteServerRequest, AsyncHandler<DeleteServerRequest,DeleteServerResult> asyncHandler)` Deletes the file transfer protocol-enabled server that you specify.
`Future<DeleteSshPublicKeyResult>`	`deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest)` Deletes a user's Secure Shell (SSH) public key.
`Future<DeleteSshPublicKeyResult>`	`deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest, AsyncHandler<DeleteSshPublicKeyRequest,DeleteSshPublicKeyResult> asyncHandler)` Deletes a user's Secure Shell (SSH) public key.
`Future<DeleteUserResult>`	`deleteUserAsync(DeleteUserRequest deleteUserRequest)` Deletes the user belonging to a file transfer protocol-enabled server you specify.
`Future<DeleteUserResult>`	`deleteUserAsync(DeleteUserRequest deleteUserRequest, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)` Deletes the user belonging to a file transfer protocol-enabled server you specify.
`Future<DeleteWorkflowResult>`	`deleteWorkflowAsync(DeleteWorkflowRequest deleteWorkflowRequest)` Deletes the specified workflow.
`Future<DeleteWorkflowResult>`	`deleteWorkflowAsync(DeleteWorkflowRequest deleteWorkflowRequest, AsyncHandler<DeleteWorkflowRequest,DeleteWorkflowResult> asyncHandler)` Deletes the specified workflow.
`Future<DescribeAccessResult>`	`describeAccessAsync(DescribeAccessRequest describeAccessRequest)` 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 describeAccessRequest, 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 describeExecutionRequest)` You can use `DescribeExecution` to check the details of the execution of the specified workflow.
`Future<DescribeExecutionResult>`	`describeExecutionAsync(DescribeExecutionRequest describeExecutionRequest, AsyncHandler<DescribeExecutionRequest,DescribeExecutionResult> asyncHandler)` You can use `DescribeExecution` to check the details of the execution of the specified workflow.
`Future<DescribeSecurityPolicyResult>`	`describeSecurityPolicyAsync(DescribeSecurityPolicyRequest describeSecurityPolicyRequest)` Describes the security policy that is attached to your file transfer protocol-enabled server.
`Future<DescribeSecurityPolicyResult>`	`describeSecurityPolicyAsync(DescribeSecurityPolicyRequest describeSecurityPolicyRequest, AsyncHandler<DescribeSecurityPolicyRequest,DescribeSecurityPolicyResult> asyncHandler)` Describes the security policy that is attached to your file transfer protocol-enabled server.
`Future<DescribeServerResult>`	`describeServerAsync(DescribeServerRequest describeServerRequest)` Describes a file transfer protocol-enabled server that you specify by passing the `ServerId` parameter.
`Future<DescribeServerResult>`	`describeServerAsync(DescribeServerRequest describeServerRequest, AsyncHandler<DescribeServerRequest,DescribeServerResult> asyncHandler)` Describes a file transfer protocol-enabled server that you specify by passing the `ServerId` parameter.
`Future<DescribeUserResult>`	`describeUserAsync(DescribeUserRequest describeUserRequest)` Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its `ServerId` property.
`Future<DescribeUserResult>`	`describeUserAsync(DescribeUserRequest describeUserRequest, 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 describeWorkflowRequest)` Describes the specified workflow.
`Future<DescribeWorkflowResult>`	`describeWorkflowAsync(DescribeWorkflowRequest describeWorkflowRequest, AsyncHandler<DescribeWorkflowRequest,DescribeWorkflowResult> asyncHandler)` Describes the specified workflow.
`Future<ImportSshPublicKeyResult>`	`importSshPublicKeyAsync(ImportSshPublicKeyRequest importSshPublicKeyRequest)` 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 importSshPublicKeyRequest, 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 listAccessesRequest)` Lists the details for all the accesses you have on your server.
`Future<ListAccessesResult>`	`listAccessesAsync(ListAccessesRequest listAccessesRequest, AsyncHandler<ListAccessesRequest,ListAccessesResult> asyncHandler)` Lists the details for all the accesses you have on your server.
`Future<ListExecutionsResult>`	`listExecutionsAsync(ListExecutionsRequest listExecutionsRequest)` Lists all executions for the specified workflow.
`Future<ListExecutionsResult>`	`listExecutionsAsync(ListExecutionsRequest listExecutionsRequest, AsyncHandler<ListExecutionsRequest,ListExecutionsResult> asyncHandler)` Lists all executions for the specified workflow.
`Future<ListSecurityPoliciesResult>`	`listSecurityPoliciesAsync(ListSecurityPoliciesRequest listSecurityPoliciesRequest)` Lists the security policies that are attached to your file transfer protocol-enabled servers.
`Future<ListSecurityPoliciesResult>`	`listSecurityPoliciesAsync(ListSecurityPoliciesRequest listSecurityPoliciesRequest, AsyncHandler<ListSecurityPoliciesRequest,ListSecurityPoliciesResult> asyncHandler)` Lists the security policies that are attached to your file transfer protocol-enabled servers.
`Future<ListServersResult>`	`listServersAsync(ListServersRequest listServersRequest)` Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
`Future<ListServersResult>`	`listServersAsync(ListServersRequest listServersRequest, AsyncHandler<ListServersRequest,ListServersResult> asyncHandler)` Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
`Future<ListTagsForResourceResult>`	`listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)` Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
`Future<ListTagsForResourceResult>`	`listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)` Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
`Future<ListUsersResult>`	`listUsersAsync(ListUsersRequest listUsersRequest)` Lists the users for a file transfer protocol-enabled server that you specify by passing the `ServerId` parameter.
`Future<ListUsersResult>`	`listUsersAsync(ListUsersRequest listUsersRequest, 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 listWorkflowsRequest)` Lists all of your workflows.
`Future<ListWorkflowsResult>`	`listWorkflowsAsync(ListWorkflowsRequest listWorkflowsRequest, AsyncHandler<ListWorkflowsRequest,ListWorkflowsResult> asyncHandler)` Lists all of your workflows.
`Future<SendWorkflowStepStateResult>`	`sendWorkflowStepStateAsync(SendWorkflowStepStateRequest sendWorkflowStepStateRequest)` Sends a callback for asynchronous custom steps.
`Future<SendWorkflowStepStateResult>`	`sendWorkflowStepStateAsync(SendWorkflowStepStateRequest sendWorkflowStepStateRequest, AsyncHandler<SendWorkflowStepStateRequest,SendWorkflowStepStateResult> asyncHandler)` Sends a callback for asynchronous custom steps.
`Future<StartServerResult>`	`startServerAsync(StartServerRequest startServerRequest)` Changes the state of a file transfer protocol-enabled server from `OFFLINE` to `ONLINE`.
`Future<StartServerResult>`	`startServerAsync(StartServerRequest startServerRequest, AsyncHandler<StartServerRequest,StartServerResult> asyncHandler)` Changes the state of a file transfer protocol-enabled server from `OFFLINE` to `ONLINE`.
`Future<StopServerResult>`	`stopServerAsync(StopServerRequest stopServerRequest)` Changes the state of a file transfer protocol-enabled server from `ONLINE` to `OFFLINE`.
`Future<StopServerResult>`	`stopServerAsync(StopServerRequest stopServerRequest, AsyncHandler<StopServerRequest,StopServerResult> asyncHandler)` Changes the state of a file transfer protocol-enabled server from `ONLINE` to `OFFLINE`.
`Future<TagResourceResult>`	`tagResourceAsync(TagResourceRequest tagResourceRequest)` Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
`Future<TagResourceResult>`	`tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)` Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
`Future<TestIdentityProviderResult>`	`testIdentityProviderAsync(TestIdentityProviderRequest testIdentityProviderRequest)` 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 testIdentityProviderRequest, 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 untagResourceRequest)` Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
`Future<UntagResourceResult>`	`untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)` Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
`Future<UpdateAccessResult>`	`updateAccessAsync(UpdateAccessRequest updateAccessRequest)` Allows you to update parameters for the access specified in the `ServerID` and `ExternalID` parameters.
`Future<UpdateAccessResult>`	`updateAccessAsync(UpdateAccessRequest updateAccessRequest, AsyncHandler<UpdateAccessRequest,UpdateAccessResult> asyncHandler)` Allows you to update parameters for the access specified in the `ServerID` and `ExternalID` parameters.
`Future<UpdateServerResult>`	`updateServerAsync(UpdateServerRequest updateServerRequest)` Updates the file transfer protocol-enabled server's properties after that server has been created.
`Future<UpdateServerResult>`	`updateServerAsync(UpdateServerRequest updateServerRequest, AsyncHandler<UpdateServerRequest,UpdateServerResult> asyncHandler)` Updates the file transfer protocol-enabled server's properties after that server has been created.
`Future<UpdateUserResult>`	`updateUserAsync(UpdateUserRequest updateUserRequest)` Assigns new properties to a user.
`Future<UpdateUserResult>`	`updateUserAsync(UpdateUserRequest updateUserRequest, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)` Assigns new properties to a user.

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, shutdown, startServer, stopServer, tagResource, testIdentityProvider, untagResource, updateAccess, updateServer, updateUser, waiters

- Method Detail
  - createAccessAsync
```
Future<CreateAccessResult> createAccessAsync(CreateAccessRequest createAccessRequest)
```
    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.
    
    Parameters:
    
    createAccessRequest -
    
    Returns:
    
    A Java Future containing the result of the CreateAccess operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAccessAsync
```
Future<CreateAccessResult> createAccessAsync(CreateAccessRequest createAccessRequest,
                                             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. 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.
    
    Parameters:
    
    createAccessRequest -
    
    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
```
Future<CreateServerResult> createServerAsync(CreateServerRequest createServerRequest)
```
    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.
    
    Parameters:
    
    createServerRequest -
    
    Returns:
    
    A Java Future containing the result of the CreateServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createServerAsync
```
Future<CreateServerResult> createServerAsync(CreateServerRequest createServerRequest,
                                             AsyncHandler<CreateServerRequest,CreateServerResult> asyncHandler)
```
    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.
    
    Parameters:
    
    createServerRequest -
    
    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
```
Future<CreateUserResult> createUserAsync(CreateUserRequest createUserRequest)
```
    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.
    
    Parameters:
    
    createUserRequest -
    
    Returns:
    
    A Java Future containing the result of the CreateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createUserAsync
```
Future<CreateUserResult> createUserAsync(CreateUserRequest createUserRequest,
                                         AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
```
    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.
    
    Parameters:
    
    createUserRequest -
    
    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
```
Future<CreateWorkflowResult> createWorkflowAsync(CreateWorkflowRequest createWorkflowRequest)
```
    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.
    
    Parameters:
    
    createWorkflowRequest -
    
    Returns:
    
    A Java Future containing the result of the CreateWorkflow operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createWorkflowAsync
```
Future<CreateWorkflowResult> createWorkflowAsync(CreateWorkflowRequest createWorkflowRequest,
                                                 AsyncHandler<CreateWorkflowRequest,CreateWorkflowResult> asyncHandler)
```
    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.
    
    Parameters:
    
    createWorkflowRequest -
    
    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
```
Future<DeleteAccessResult> deleteAccessAsync(DeleteAccessRequest deleteAccessRequest)
```
    Allows you to delete the access specified in the ServerID and ExternalID parameters.
    
    Parameters:
    
    deleteAccessRequest -
    
    Returns:
    
    A Java Future containing the result of the DeleteAccess operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAccessAsync
```
Future<DeleteAccessResult> deleteAccessAsync(DeleteAccessRequest deleteAccessRequest,
                                             AsyncHandler<DeleteAccessRequest,DeleteAccessResult> asyncHandler)
```
    Allows you to delete the access specified in the ServerID and ExternalID parameters.
    
    Parameters:
    
    deleteAccessRequest -
    
    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
```
Future<DeleteServerResult> deleteServerAsync(DeleteServerRequest deleteServerRequest)
```
    Deletes the file transfer protocol-enabled server that you specify.
    
    No response returns from this operation.
    
    Parameters:
    
    deleteServerRequest -
    
    Returns:
    
    A Java Future containing the result of the DeleteServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteServerAsync
```
Future<DeleteServerResult> deleteServerAsync(DeleteServerRequest deleteServerRequest,
                                             AsyncHandler<DeleteServerRequest,DeleteServerResult> asyncHandler)
```
    Deletes the file transfer protocol-enabled server that you specify.
    
    No response returns from this operation.
    
    Parameters:
    
    deleteServerRequest -
    
    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
```
Future<DeleteSshPublicKeyResult> deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest)
```
    Deletes a user's Secure Shell (SSH) public key.
    
    Parameters:
    
    deleteSshPublicKeyRequest -
    
    Returns:
    
    A Java Future containing the result of the DeleteSshPublicKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteSshPublicKeyAsync
```
Future<DeleteSshPublicKeyResult> deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest,
                                                         AsyncHandler<DeleteSshPublicKeyRequest,DeleteSshPublicKeyResult> asyncHandler)
```
    Deletes a user's Secure Shell (SSH) public key.
    
    Parameters:
    
    deleteSshPublicKeyRequest -
    
    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
```
Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest)
```
    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.
    
    Parameters:
    
    deleteUserRequest -
    
    Returns:
    
    A Java Future containing the result of the DeleteUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUserAsync
```
Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest,
                                         AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
```
    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.
    
    Parameters:
    
    deleteUserRequest -
    
    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
```
Future<DeleteWorkflowResult> deleteWorkflowAsync(DeleteWorkflowRequest deleteWorkflowRequest)
```
    Deletes the specified workflow.
    
    Parameters:
    
    deleteWorkflowRequest -
    
    Returns:
    
    A Java Future containing the result of the DeleteWorkflow operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteWorkflowAsync
```
Future<DeleteWorkflowResult> deleteWorkflowAsync(DeleteWorkflowRequest deleteWorkflowRequest,
                                                 AsyncHandler<DeleteWorkflowRequest,DeleteWorkflowResult> asyncHandler)
```
    Deletes the specified workflow.
    
    Parameters:
    
    deleteWorkflowRequest -
    
    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
```
Future<DescribeAccessResult> describeAccessAsync(DescribeAccessRequest describeAccessRequest)
```
    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.
    
    Parameters:
    
    describeAccessRequest -
    
    Returns:
    
    A Java Future containing the result of the DescribeAccess operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAccessAsync
```
Future<DescribeAccessResult> describeAccessAsync(DescribeAccessRequest describeAccessRequest,
                                                 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.
    
    The response from this call returns the properties of the access that is associated with the ServerId value that was specified.
    
    Parameters:
    
    describeAccessRequest -
    
    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
```
Future<DescribeExecutionResult> describeExecutionAsync(DescribeExecutionRequest describeExecutionRequest)
```
    You can use DescribeExecution to check the details of the execution of the specified workflow.
    
    Parameters:
    
    describeExecutionRequest -
    
    Returns:
    
    A Java Future containing the result of the DescribeExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeExecutionAsync
```
Future<DescribeExecutionResult> describeExecutionAsync(DescribeExecutionRequest describeExecutionRequest,
                                                       AsyncHandler<DescribeExecutionRequest,DescribeExecutionResult> asyncHandler)
```
    You can use DescribeExecution to check the details of the execution of the specified workflow.
    
    Parameters:
    
    describeExecutionRequest -
    
    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
```
Future<DescribeSecurityPolicyResult> describeSecurityPolicyAsync(DescribeSecurityPolicyRequest describeSecurityPolicyRequest)
```
    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.
    
    Parameters:
    
    describeSecurityPolicyRequest -
    
    Returns:
    
    A Java Future containing the result of the DescribeSecurityPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeSecurityPolicyAsync
```
Future<DescribeSecurityPolicyResult> describeSecurityPolicyAsync(DescribeSecurityPolicyRequest describeSecurityPolicyRequest,
                                                                 AsyncHandler<DescribeSecurityPolicyRequest,DescribeSecurityPolicyResult> asyncHandler)
```
    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.
    
    Parameters:
    
    describeSecurityPolicyRequest -
    
    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
```
Future<DescribeServerResult> describeServerAsync(DescribeServerRequest describeServerRequest)
```
    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.
    
    Parameters:
    
    describeServerRequest -
    
    Returns:
    
    A Java Future containing the result of the DescribeServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeServerAsync
```
Future<DescribeServerResult> describeServerAsync(DescribeServerRequest describeServerRequest,
                                                 AsyncHandler<DescribeServerRequest,DescribeServerResult> asyncHandler)
```
    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.
    
    Parameters:
    
    describeServerRequest -
    
    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
```
Future<DescribeUserResult> describeUserAsync(DescribeUserRequest describeUserRequest)
```
    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.
    
    Parameters:
    
    describeUserRequest -
    
    Returns:
    
    A Java Future containing the result of the DescribeUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeUserAsync
```
Future<DescribeUserResult> describeUserAsync(DescribeUserRequest describeUserRequest,
                                             AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)
```
    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.
    
    Parameters:
    
    describeUserRequest -
    
    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
```
Future<DescribeWorkflowResult> describeWorkflowAsync(DescribeWorkflowRequest describeWorkflowRequest)
```
    Describes the specified workflow.
    
    Parameters:
    
    describeWorkflowRequest -
    
    Returns:
    
    A Java Future containing the result of the DescribeWorkflow operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeWorkflowAsync
```
Future<DescribeWorkflowResult> describeWorkflowAsync(DescribeWorkflowRequest describeWorkflowRequest,
                                                     AsyncHandler<DescribeWorkflowRequest,DescribeWorkflowResult> asyncHandler)
```
    Describes the specified workflow.
    
    Parameters:
    
    describeWorkflowRequest -
    
    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
```
Future<ImportSshPublicKeyResult> importSshPublicKeyAsync(ImportSshPublicKeyRequest importSshPublicKeyRequest)
```
    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.
    
    Parameters:
    
    importSshPublicKeyRequest -
    
    Returns:
    
    A Java Future containing the result of the ImportSshPublicKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importSshPublicKeyAsync
```
Future<ImportSshPublicKeyResult> importSshPublicKeyAsync(ImportSshPublicKeyRequest importSshPublicKeyRequest,
                                                         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.
    
    The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.
    
    Parameters:
    
    importSshPublicKeyRequest -
    
    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
```
Future<ListAccessesResult> listAccessesAsync(ListAccessesRequest listAccessesRequest)
```
    Lists the details for all the accesses you have on your server.
    
    Parameters:
    
    listAccessesRequest -
    
    Returns:
    
    A Java Future containing the result of the ListAccesses operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAccessesAsync
```
Future<ListAccessesResult> listAccessesAsync(ListAccessesRequest listAccessesRequest,
                                             AsyncHandler<ListAccessesRequest,ListAccessesResult> asyncHandler)
```
    Lists the details for all the accesses you have on your server.
    
    Parameters:
    
    listAccessesRequest -
    
    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
```
Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest listExecutionsRequest)
```
    Lists all executions for the specified workflow.
    
    Parameters:
    
    listExecutionsRequest -
    
    Returns:
    
    A Java Future containing the result of the ListExecutions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listExecutionsAsync
```
Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest listExecutionsRequest,
                                                 AsyncHandler<ListExecutionsRequest,ListExecutionsResult> asyncHandler)
```
    Lists all executions for the specified workflow.
    
    Parameters:
    
    listExecutionsRequest -
    
    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
```
Future<ListSecurityPoliciesResult> listSecurityPoliciesAsync(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
```
    Lists the security policies that are attached to your file transfer protocol-enabled servers.
    
    Parameters:
    
    listSecurityPoliciesRequest -
    
    Returns:
    
    A Java Future containing the result of the ListSecurityPolicies operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSecurityPoliciesAsync
```
Future<ListSecurityPoliciesResult> listSecurityPoliciesAsync(ListSecurityPoliciesRequest listSecurityPoliciesRequest,
                                                             AsyncHandler<ListSecurityPoliciesRequest,ListSecurityPoliciesResult> asyncHandler)
```
    Lists the security policies that are attached to your file transfer protocol-enabled servers.
    
    Parameters:
    
    listSecurityPoliciesRequest -
    
    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
```
Future<ListServersResult> listServersAsync(ListServersRequest listServersRequest)
```
    Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
    
    Parameters:
    
    listServersRequest -
    
    Returns:
    
    A Java Future containing the result of the ListServers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listServersAsync
```
Future<ListServersResult> listServersAsync(ListServersRequest listServersRequest,
                                           AsyncHandler<ListServersRequest,ListServersResult> asyncHandler)
```
    Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
    
    Parameters:
    
    listServersRequest -
    
    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
```
Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    A Java Future containing the result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResourceAsync
```
Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
                                                           AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
```
    Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    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
```
Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest)
```
    Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
    
    Parameters:
    
    listUsersRequest -
    
    Returns:
    
    A Java Future containing the result of the ListUsers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUsersAsync
```
Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest,
                                       AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
```
    Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
    
    Parameters:
    
    listUsersRequest -
    
    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
```
Future<ListWorkflowsResult> listWorkflowsAsync(ListWorkflowsRequest listWorkflowsRequest)
```
    Lists all of your workflows.
    
    Parameters:
    
    listWorkflowsRequest -
    
    Returns:
    
    A Java Future containing the result of the ListWorkflows operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listWorkflowsAsync
```
Future<ListWorkflowsResult> listWorkflowsAsync(ListWorkflowsRequest listWorkflowsRequest,
                                               AsyncHandler<ListWorkflowsRequest,ListWorkflowsResult> asyncHandler)
```
    Lists all of your workflows.
    
    Parameters:
    
    listWorkflowsRequest -
    
    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
```
Future<SendWorkflowStepStateResult> sendWorkflowStepStateAsync(SendWorkflowStepStateRequest sendWorkflowStepStateRequest)
```
    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.
    
    Parameters:
    
    sendWorkflowStepStateRequest -
    
    Returns:
    
    A Java Future containing the result of the SendWorkflowStepState operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - sendWorkflowStepStateAsync
```
Future<SendWorkflowStepStateResult> sendWorkflowStepStateAsync(SendWorkflowStepStateRequest sendWorkflowStepStateRequest,
                                                               AsyncHandler<SendWorkflowStepStateRequest,SendWorkflowStepStateResult> asyncHandler)
```
    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.
    
    Parameters:
    
    sendWorkflowStepStateRequest -
    
    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
```
Future<StartServerResult> startServerAsync(StartServerRequest startServerRequest)
```
    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.
    
    Parameters:
    
    startServerRequest -
    
    Returns:
    
    A Java Future containing the result of the StartServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startServerAsync
```
Future<StartServerResult> startServerAsync(StartServerRequest startServerRequest,
                                           AsyncHandler<StartServerRequest,StartServerResult> asyncHandler)
```
    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.
    
    Parameters:
    
    startServerRequest -
    
    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
```
Future<StopServerResult> stopServerAsync(StopServerRequest stopServerRequest)
```
    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.
    
    Parameters:
    
    stopServerRequest -
    
    Returns:
    
    A Java Future containing the result of the StopServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopServerAsync
```
Future<StopServerResult> stopServerAsync(StopServerRequest stopServerRequest,
                                         AsyncHandler<StopServerRequest,StopServerResult> asyncHandler)
```
    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.
    
    Parameters:
    
    stopServerRequest -
    
    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
```
Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
```
    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.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    A Java Future containing the result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResourceAsync
```
Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest,
                                           AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
```
    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.
    
    Parameters:
    
    tagResourceRequest -
    
    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
```
Future<TestIdentityProviderResult> testIdentityProviderAsync(TestIdentityProviderRequest testIdentityProviderRequest)
```
    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
    Parameters:
    
    testIdentityProviderRequest -
    
    Returns:
    
    A Java Future containing the result of the TestIdentityProvider operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - testIdentityProviderAsync
```
Future<TestIdentityProviderResult> testIdentityProviderAsync(TestIdentityProviderRequest testIdentityProviderRequest,
                                                             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. 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
    Parameters:
    
    testIdentityProviderRequest -
    
    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
```
Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
```
    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.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    A Java Future containing the result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResourceAsync
```
Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest,
                                               AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
```
    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.
    
    Parameters:
    
    untagResourceRequest -
    
    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
```
Future<UpdateAccessResult> updateAccessAsync(UpdateAccessRequest updateAccessRequest)
```
    Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.
    
    Parameters:
    
    updateAccessRequest -
    
    Returns:
    
    A Java Future containing the result of the UpdateAccess operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAccessAsync
```
Future<UpdateAccessResult> updateAccessAsync(UpdateAccessRequest updateAccessRequest,
                                             AsyncHandler<UpdateAccessRequest,UpdateAccessResult> asyncHandler)
```
    Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.
    
    Parameters:
    
    updateAccessRequest -
    
    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
```
Future<UpdateServerResult> updateServerAsync(UpdateServerRequest updateServerRequest)
```
    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.
    
    Parameters:
    
    updateServerRequest -
    
    Returns:
    
    A Java Future containing the result of the UpdateServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateServerAsync
```
Future<UpdateServerResult> updateServerAsync(UpdateServerRequest updateServerRequest,
                                             AsyncHandler<UpdateServerRequest,UpdateServerResult> asyncHandler)
```
    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.
    
    Parameters:
    
    updateServerRequest -
    
    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
```
Future<UpdateUserResult> updateUserAsync(UpdateUserRequest updateUserRequest)
```
    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.
    
    Parameters:
    
    updateUserRequest -
    
    Returns:
    
    A Java Future containing the result of the UpdateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateUserAsync
```
Future<UpdateUserResult> updateUserAsync(UpdateUserRequest updateUserRequest,
                                         AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
```
    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.
    
    Parameters:
    
    updateUserRequest -
    
    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?

Interface AWSTransferAsync

Field Summary

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

Method Summary

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

Method Detail

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