com.amazonaws.services.transfer

Interface AWSTransferAsync

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.

AWS 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). AWS helps you seamlessly migrate your file transfer workflows to AWS 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 AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS 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

Modifier and Type	Method and Description
Future<CreateServerResult>	createServerAsync(CreateServerRequest createServerRequest) Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS.
Future<CreateServerResult>	createServerAsync(CreateServerRequest createServerRequest, AsyncHandler<CreateServerRequest,CreateServerResult> asyncHandler) Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS.
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<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<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<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<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 AWS account.
Future<ListServersResult>	listServersAsync(ListServersRequest listServersRequest, AsyncHandler<ListServersRequest,ListServersResult> asyncHandler) Lists the file transfer protocol-enabled servers that are associated with your AWS account.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest) Lists all of the tags associated with the Amazon Resource Number (ARN) you specify.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler) Lists all of the tags associated with the Amazon Resource Number (ARN) 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<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 API_Gateway, tests whether your API Gateway is set up successfully.
Future<TestIdentityProviderResult>	testIdentityProviderAsync(TestIdentityProviderRequest testIdentityProviderRequest, AsyncHandler<TestIdentityProviderRequest,TestIdentityProviderResult> asyncHandler) If the IdentityProviderType of a file transfer protocol-enabled server is API_Gateway, tests whether your API Gateway 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<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

createServer, createUser, deleteServer, deleteSshPublicKey, deleteUser, describeSecurityPolicy, describeServer, describeUser, getCachedResponseMetadata, importSshPublicKey, listSecurityPolicies, listServers, listTagsForResource, listUsers, shutdown, startServer, stopServer, tagResource, testIdentityProvider, untagResource, updateServer, updateUser

Method Detail

createServerAsync

Future<CreateServerResult> createServerAsync(CreateServerRequest createServerRequest)

Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS. 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 autoscaling virtual server based on the selected file transfer protocol in AWS. 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 AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.

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 AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.

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

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.

No response is returned from this operation.

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.

No response is returned from this operation.

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

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

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

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 AWS 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 AWS 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 Number (ARN) 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 Number (ARN) 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

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 API_Gateway, tests whether your API Gateway 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 API Gateway integration to ensure that your users can successfully use the service.

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 API_Gateway, tests whether your API Gateway 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 API Gateway integration to ensure that your users can successfully use the service.

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

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