@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSTransferAsyncClient extends AWSTransferClient implements AWSTransferAsync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
AWS Transfer for SFTP is a fully managed service that enables the transfer of files directly into and out of Amazon S3 using the Secure File Transfer Protocol (SFTP)—also known as Secure Shell (SSH) File Transfer Protocol. AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer for SFTP—by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53—so nothing changes for your customers and partners, or their applications. With your data in S3, you can use it with AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer for SFTP (AWS SFTP) is easy; there is no infrastructure to buy and setup.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
static AWSTransferAsyncClientBuilder |
asyncBuilder() |
Future<CreateServerResult> |
createServerAsync(CreateServerRequest request)
Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS.
|
Future<CreateServerResult> |
createServerAsync(CreateServerRequest request,
AsyncHandler<CreateServerRequest,CreateServerResult> asyncHandler)
Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS.
|
Future<CreateUserResult> |
createUserAsync(CreateUserRequest request)
Adds a user and associate them with an existing Secure File Transfer Protocol (SFTP) server.
|
Future<CreateUserResult> |
createUserAsync(CreateUserRequest request,
AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
Adds a user and associate them with an existing Secure File Transfer Protocol (SFTP) server.
|
Future<DeleteServerResult> |
deleteServerAsync(DeleteServerRequest request)
Deletes the Secure File Transfer Protocol (SFTP) server that you specify.
|
Future<DeleteServerResult> |
deleteServerAsync(DeleteServerRequest request,
AsyncHandler<DeleteServerRequest,DeleteServerResult> asyncHandler)
Deletes the Secure File Transfer Protocol (SFTP) server that you specify.
|
Future<DeleteSshPublicKeyResult> |
deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest request)
Deletes a user's Secure Shell (SSH) public key.
|
Future<DeleteSshPublicKeyResult> |
deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest request,
AsyncHandler<DeleteSshPublicKeyRequest,DeleteSshPublicKeyResult> asyncHandler)
Deletes a user's Secure Shell (SSH) public key.
|
Future<DeleteUserResult> |
deleteUserAsync(DeleteUserRequest request)
Deletes the user belonging to the server you specify.
|
Future<DeleteUserResult> |
deleteUserAsync(DeleteUserRequest request,
AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
Deletes the user belonging to the server you specify.
|
Future<DescribeServerResult> |
describeServerAsync(DescribeServerRequest request)
Describes the server that you specify by passing the
ServerId parameter. |
Future<DescribeServerResult> |
describeServerAsync(DescribeServerRequest request,
AsyncHandler<DescribeServerRequest,DescribeServerResult> asyncHandler)
Describes the server that you specify by passing the
ServerId parameter. |
Future<DescribeUserResult> |
describeUserAsync(DescribeUserRequest request)
Describes the user assigned to a specific server, as identified by its
ServerId property. |
Future<DescribeUserResult> |
describeUserAsync(DescribeUserRequest request,
AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)
Describes the user assigned to a specific server, as identified by its
ServerId property. |
ExecutorService |
getExecutorService()
Returns the executor service used by this client to execute async requests.
|
Future<ImportSshPublicKeyResult> |
importSshPublicKeyAsync(ImportSshPublicKeyRequest request)
Adds a Secure Shell (SSH) public key to a user account identified by a
UserName value assigned to a
specific server, identified by ServerId . |
Future<ImportSshPublicKeyResult> |
importSshPublicKeyAsync(ImportSshPublicKeyRequest request,
AsyncHandler<ImportSshPublicKeyRequest,ImportSshPublicKeyResult> asyncHandler)
Adds a Secure Shell (SSH) public key to a user account identified by a
UserName value assigned to a
specific server, identified by ServerId . |
Future<ListServersResult> |
listServersAsync(ListServersRequest request)
Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.
|
Future<ListServersResult> |
listServersAsync(ListServersRequest request,
AsyncHandler<ListServersRequest,ListServersResult> asyncHandler)
Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest request)
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest request,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify.
|
Future<ListUsersResult> |
listUsersAsync(ListUsersRequest request)
Lists the users for the server that you specify by passing the
ServerId parameter. |
Future<ListUsersResult> |
listUsersAsync(ListUsersRequest request,
AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
Lists the users for the server that you specify by passing the
ServerId parameter. |
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
Future<StartServerResult> |
startServerAsync(StartServerRequest request)
Changes the state of a Secure File Transfer Protocol (SFTP) server from
OFFLINE to
ONLINE . |
Future<StartServerResult> |
startServerAsync(StartServerRequest request,
AsyncHandler<StartServerRequest,StartServerResult> asyncHandler)
Changes the state of a Secure File Transfer Protocol (SFTP) server from
OFFLINE to
ONLINE . |
Future<StopServerResult> |
stopServerAsync(StopServerRequest request)
Changes the state of an SFTP server from
ONLINE to OFFLINE . |
Future<StopServerResult> |
stopServerAsync(StopServerRequest request,
AsyncHandler<StopServerRequest,StopServerResult> asyncHandler)
Changes the state of an SFTP server from
ONLINE to OFFLINE . |
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest request)
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest request,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
|
Future<TestIdentityProviderResult> |
testIdentityProviderAsync(TestIdentityProviderRequest request)
If the
IdentityProviderType of the server is API_Gateway , tests whether your API
Gateway is set up successfully. |
Future<TestIdentityProviderResult> |
testIdentityProviderAsync(TestIdentityProviderRequest request,
AsyncHandler<TestIdentityProviderRequest,TestIdentityProviderResult> asyncHandler)
If the
IdentityProviderType of the server is API_Gateway , tests whether your API
Gateway is set up successfully. |
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest request)
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest request,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
|
Future<UpdateServerResult> |
updateServerAsync(UpdateServerRequest request)
Updates the server properties after that server has been created.
|
Future<UpdateServerResult> |
updateServerAsync(UpdateServerRequest request,
AsyncHandler<UpdateServerRequest,UpdateServerResult> asyncHandler)
Updates the server properties after that server has been created.
|
Future<UpdateUserResult> |
updateUserAsync(UpdateUserRequest request)
Assigns new properties to a user.
|
Future<UpdateUserResult> |
updateUserAsync(UpdateUserRequest request,
AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
Assigns new properties to a user.
|
builder, createServer, createUser, deleteServer, deleteSshPublicKey, deleteUser, describeServer, describeUser, getCachedResponseMetadata, importSshPublicKey, listServers, listTagsForResource, listUsers, startServer, stopServer, tagResource, testIdentityProvider, untagResource, updateServer, updateUser
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createServer, createUser, deleteServer, deleteSshPublicKey, deleteUser, describeServer, describeUser, getCachedResponseMetadata, importSshPublicKey, listServers, listTagsForResource, listUsers, startServer, stopServer, tagResource, testIdentityProvider, untagResource, updateServer, updateUser
public static AWSTransferAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateServerResult> createServerAsync(CreateServerRequest request)
AWSTransferAsync
Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. The call returns
the ServerId
property assigned by the service to the newly created server. Reference this
ServerId
property when you make updates to your server, or work with users.
The response returns the ServerId
value for the newly created server.
createServerAsync
in interface AWSTransferAsync
public Future<CreateServerResult> createServerAsync(CreateServerRequest request, AsyncHandler<CreateServerRequest,CreateServerResult> asyncHandler)
AWSTransferAsync
Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. The call returns
the ServerId
property assigned by the service to the newly created server. Reference this
ServerId
property when you make updates to your server, or work with users.
The response returns the ServerId
value for the newly created server.
createServerAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateUserResult> createUserAsync(CreateUserRequest request)
AWSTransferAsync
Adds a user and associate them with an existing Secure File Transfer Protocol (SFTP) server. Using parameters for
CreateUser
, you can specify the user name, set the home directory, store the user's public key, and
assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy,
and assign metadata with tags that can be used to group and search for users.
The response returns the UserName
and ServerId
values of the new user for that server.
createUserAsync
in interface AWSTransferAsync
public Future<CreateUserResult> createUserAsync(CreateUserRequest request, AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
AWSTransferAsync
Adds a user and associate them with an existing Secure File Transfer Protocol (SFTP) server. Using parameters for
CreateUser
, you can specify the user name, set the home directory, store the user's public key, and
assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy,
and assign metadata with tags that can be used to group and search for users.
The response returns the UserName
and ServerId
values of the new user for that server.
createUserAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteServerResult> deleteServerAsync(DeleteServerRequest request)
AWSTransferAsync
Deletes the Secure File Transfer Protocol (SFTP) server that you specify. If you used
SERVICE_MANAGED
as your IdentityProviderType
, you need to delete all users associated
with this server before deleting the server itself
No response returns from this call.
deleteServerAsync
in interface AWSTransferAsync
public Future<DeleteServerResult> deleteServerAsync(DeleteServerRequest request, AsyncHandler<DeleteServerRequest,DeleteServerResult> asyncHandler)
AWSTransferAsync
Deletes the Secure File Transfer Protocol (SFTP) server that you specify. If you used
SERVICE_MANAGED
as your IdentityProviderType
, you need to delete all users associated
with this server before deleting the server itself
No response returns from this call.
deleteServerAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteSshPublicKeyResult> deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest request)
AWSTransferAsync
Deletes a user's Secure Shell (SSH) public key.
No response is returned from this call.
deleteSshPublicKeyAsync
in interface AWSTransferAsync
public Future<DeleteSshPublicKeyResult> deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest request, AsyncHandler<DeleteSshPublicKeyRequest,DeleteSshPublicKeyResult> asyncHandler)
AWSTransferAsync
Deletes a user's Secure Shell (SSH) public key.
No response is returned from this call.
deleteSshPublicKeyAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request)
AWSTransferAsync
Deletes the user belonging to the server you specify.
No response returns from this call.
When you delete a user from a server, the user's information is lost.
deleteUserAsync
in interface AWSTransferAsync
public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
AWSTransferAsync
Deletes the user belonging to the server you specify.
No response returns from this call.
When you delete a user from a server, the user's information is lost.
deleteUserAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeServerResult> describeServerAsync(DescribeServerRequest request)
AWSTransferAsync
Describes the server that you specify by passing the ServerId
parameter.
The response contains a description of the server's properties.
describeServerAsync
in interface AWSTransferAsync
public Future<DescribeServerResult> describeServerAsync(DescribeServerRequest request, AsyncHandler<DescribeServerRequest,DescribeServerResult> asyncHandler)
AWSTransferAsync
Describes the server that you specify by passing the ServerId
parameter.
The response contains a description of the server's properties.
describeServerAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request)
AWSTransferAsync
Describes the user assigned to a specific server, as identified by its ServerId
property.
The response from this call returns the properties of the user associated with the ServerId
value
that was specified.
describeUserAsync
in interface AWSTransferAsync
public Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request, AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)
AWSTransferAsync
Describes the user assigned to a specific server, as identified by its ServerId
property.
The response from this call returns the properties of the user associated with the ServerId
value
that was specified.
describeUserAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ImportSshPublicKeyResult> importSshPublicKeyAsync(ImportSshPublicKeyRequest request)
AWSTransferAsync
Adds a Secure Shell (SSH) public key to a user account identified by a UserName
value assigned to a
specific server, identified by ServerId
.
The response returns the UserName
value, the ServerId
value, and the name of the
SshPublicKeyId
.
importSshPublicKeyAsync
in interface AWSTransferAsync
public Future<ImportSshPublicKeyResult> importSshPublicKeyAsync(ImportSshPublicKeyRequest request, AsyncHandler<ImportSshPublicKeyRequest,ImportSshPublicKeyResult> asyncHandler)
AWSTransferAsync
Adds a Secure Shell (SSH) public key to a user account identified by a UserName
value assigned to a
specific server, identified by ServerId
.
The response returns the UserName
value, the ServerId
value, and the name of the
SshPublicKeyId
.
importSshPublicKeyAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListServersResult> listServersAsync(ListServersRequest request)
AWSTransferAsync
Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.
listServersAsync
in interface AWSTransferAsync
public Future<ListServersResult> listServersAsync(ListServersRequest request, AsyncHandler<ListServersRequest,ListServersResult> asyncHandler)
AWSTransferAsync
Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.
listServersAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSTransferAsync
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.
listTagsForResourceAsync
in interface AWSTransferAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSTransferAsync
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.
listTagsForResourceAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListUsersResult> listUsersAsync(ListUsersRequest request)
AWSTransferAsync
Lists the users for the server that you specify by passing the ServerId
parameter.
listUsersAsync
in interface AWSTransferAsync
public Future<ListUsersResult> listUsersAsync(ListUsersRequest request, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
AWSTransferAsync
Lists the users for the server that you specify by passing the ServerId
parameter.
listUsersAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartServerResult> startServerAsync(StartServerRequest request)
AWSTransferAsync
Changes the state of a Secure File Transfer Protocol (SFTP) server from OFFLINE
to
ONLINE
. It has no impact on an SFTP server that is already ONLINE
. An
ONLINE
server can accept and process file transfer jobs.
The state of STARTING
indicates that the server is in an intermediate state, either not fully able
to respond, or not fully online. The values of START_FAILED
can indicate an error condition.
No response is returned from this call.
startServerAsync
in interface AWSTransferAsync
public Future<StartServerResult> startServerAsync(StartServerRequest request, AsyncHandler<StartServerRequest,StartServerResult> asyncHandler)
AWSTransferAsync
Changes the state of a Secure File Transfer Protocol (SFTP) server from OFFLINE
to
ONLINE
. It has no impact on an SFTP server that is already ONLINE
. An
ONLINE
server can accept and process file transfer jobs.
The state of STARTING
indicates that the server is in an intermediate state, either not fully able
to respond, or not fully online. The values of START_FAILED
can indicate an error condition.
No response is returned from this call.
startServerAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StopServerResult> stopServerAsync(StopServerRequest request)
AWSTransferAsync
Changes the state of an SFTP server from ONLINE
to OFFLINE
. An OFFLINE
server cannot accept and process file transfer jobs. Information tied to your server such as server and user
properties are not affected by stopping your server. Stopping a server will not reduce or impact your Secure File
Transfer Protocol (SFTP) endpoint billing.
The states of STOPPING
indicates that the server is in an intermediate state, either not fully able
to respond, or not fully offline. The values of STOP_FAILED
can indicate an error condition.
No response is returned from this call.
stopServerAsync
in interface AWSTransferAsync
public Future<StopServerResult> stopServerAsync(StopServerRequest request, AsyncHandler<StopServerRequest,StopServerResult> asyncHandler)
AWSTransferAsync
Changes the state of an SFTP server from ONLINE
to OFFLINE
. An OFFLINE
server cannot accept and process file transfer jobs. Information tied to your server such as server and user
properties are not affected by stopping your server. Stopping a server will not reduce or impact your Secure File
Transfer Protocol (SFTP) endpoint billing.
The states of STOPPING
indicates that the server is in an intermediate state, either not fully able
to respond, or not fully offline. The values of STOP_FAILED
can indicate an error condition.
No response is returned from this call.
stopServerAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSTransferAsync
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
There is no response returned from this call.
tagResourceAsync
in interface AWSTransferAsync
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSTransferAsync
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
There is no response returned from this call.
tagResourceAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TestIdentityProviderResult> testIdentityProviderAsync(TestIdentityProviderRequest request)
AWSTransferAsync
If the IdentityProviderType
of the server is API_Gateway
, tests whether your API
Gateway is set up successfully. We highly recommend that you call this method to test your authentication method
as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to
ensure that your users can successfully use the service.
testIdentityProviderAsync
in interface AWSTransferAsync
public Future<TestIdentityProviderResult> testIdentityProviderAsync(TestIdentityProviderRequest request, AsyncHandler<TestIdentityProviderRequest,TestIdentityProviderResult> asyncHandler)
AWSTransferAsync
If the IdentityProviderType
of the server is API_Gateway
, tests whether your API
Gateway is set up successfully. We highly recommend that you call this method to test your authentication method
as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to
ensure that your users can successfully use the service.
testIdentityProviderAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSTransferAsync
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
No response is returned from this call.
untagResourceAsync
in interface AWSTransferAsync
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSTransferAsync
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
No response is returned from this call.
untagResourceAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateServerResult> updateServerAsync(UpdateServerRequest request)
AWSTransferAsync
Updates the server properties after that server has been created.
The UpdateServer
call returns the ServerId
of the Secure File Transfer Protocol (SFTP)
server you updated.
updateServerAsync
in interface AWSTransferAsync
public Future<UpdateServerResult> updateServerAsync(UpdateServerRequest request, AsyncHandler<UpdateServerRequest,UpdateServerResult> asyncHandler)
AWSTransferAsync
Updates the server properties after that server has been created.
The UpdateServer
call returns the ServerId
of the Secure File Transfer Protocol (SFTP)
server you updated.
updateServerAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request)
AWSTransferAsync
Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory,
role, and policy for the UserName
and ServerId
you specify.
The response returns the ServerId
and the UserName
for the updated user.
updateUserAsync
in interface AWSTransferAsync
public Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
AWSTransferAsync
Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory,
role, and policy for the UserName
and ServerId
you specify.
The response returns the ServerId
and the UserName
for the updated user.
updateUserAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AWSTransfer
shutdown
in class AmazonWebServiceClient
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.