software.amazon.awssdk.services.transfer

Interface TransferAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface TransferAsyncClient
extends SdkClient

Service client for accessing AWS Transfer asynchronously. This can be created using the static builder() method. null

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static TransferAsyncClientBuilder	builder() Create a builder that can be used to configure and create a TransferAsyncClient.
static TransferAsyncClient	create() Create a TransferAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateServerResponse>	createServer(Consumer<CreateServerRequest.Builder> createServerRequest) Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS.
default CompletableFuture<CreateServerResponse>	createServer(CreateServerRequest createServerRequest) Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS.
default CompletableFuture<CreateUserResponse>	createUser(Consumer<CreateUserRequest.Builder> createUserRequest) Adds a user and associate them with an existing Secure File Transfer Protocol (SFTP) server.
default CompletableFuture<CreateUserResponse>	createUser(CreateUserRequest createUserRequest) Adds a user and associate them with an existing Secure File Transfer Protocol (SFTP) server.
default CompletableFuture<DeleteServerResponse>	deleteServer(Consumer<DeleteServerRequest.Builder> deleteServerRequest) Deletes the Secure File Transfer Protocol (SFTP) server that you specify.
default CompletableFuture<DeleteServerResponse>	deleteServer(DeleteServerRequest deleteServerRequest) Deletes the Secure File Transfer Protocol (SFTP) server that you specify.
default CompletableFuture<DeleteSshPublicKeyResponse>	deleteSshPublicKey(Consumer<DeleteSshPublicKeyRequest.Builder> deleteSshPublicKeyRequest) Deletes a user's Secure Shell (SSH) public key.
default CompletableFuture<DeleteSshPublicKeyResponse>	deleteSshPublicKey(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest) Deletes a user's Secure Shell (SSH) public key.
default CompletableFuture<DeleteUserResponse>	deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) Deletes the user belonging to the server you specify.
default CompletableFuture<DeleteUserResponse>	deleteUser(DeleteUserRequest deleteUserRequest) Deletes the user belonging to the server you specify.
default CompletableFuture<DescribeServerResponse>	describeServer(Consumer<DescribeServerRequest.Builder> describeServerRequest) Describes the server that you specify by passing the ServerId parameter.
default CompletableFuture<DescribeServerResponse>	describeServer(DescribeServerRequest describeServerRequest) Describes the server that you specify by passing the ServerId parameter.
default CompletableFuture<DescribeUserResponse>	describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) Describes the user assigned to a specific server, as identified by its ServerId property.
default CompletableFuture<DescribeUserResponse>	describeUser(DescribeUserRequest describeUserRequest) Describes the user assigned to a specific server, as identified by its ServerId property.
default CompletableFuture<ImportSshPublicKeyResponse>	importSshPublicKey(Consumer<ImportSshPublicKeyRequest.Builder> importSshPublicKeyRequest) Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to a specific server, identified by ServerId.
default CompletableFuture<ImportSshPublicKeyResponse>	importSshPublicKey(ImportSshPublicKeyRequest importSshPublicKeyRequest) Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to a specific server, identified by ServerId.
default CompletableFuture<ListServersResponse>	listServers() Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.
default CompletableFuture<ListServersResponse>	listServers(Consumer<ListServersRequest.Builder> listServersRequest) Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.
default CompletableFuture<ListServersResponse>	listServers(ListServersRequest listServersRequest) Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.
default CompletableFuture<ListTagsForResourceResponse>	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all of the tags associated with the Amazon Resource Number (ARN) you specify.
default CompletableFuture<ListTagsForResourceResponse>	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all of the tags associated with the Amazon Resource Number (ARN) you specify.
default CompletableFuture<ListUsersResponse>	listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) Lists the users for the server that you specify by passing the ServerId parameter.
default CompletableFuture<ListUsersResponse>	listUsers(ListUsersRequest listUsersRequest) Lists the users for the server that you specify by passing the ServerId parameter.
default CompletableFuture<StartServerResponse>	startServer(Consumer<StartServerRequest.Builder> startServerRequest) Changes the state of a Secure File Transfer Protocol (SFTP) server from OFFLINE to ONLINE.
default CompletableFuture<StartServerResponse>	startServer(StartServerRequest startServerRequest) Changes the state of a Secure File Transfer Protocol (SFTP) server from OFFLINE to ONLINE.
default CompletableFuture<StopServerResponse>	stopServer(Consumer<StopServerRequest.Builder> stopServerRequest) Changes the state of an SFTP server from ONLINE to OFFLINE.
default CompletableFuture<StopServerResponse>	stopServer(StopServerRequest stopServerRequest) Changes the state of an SFTP server from ONLINE to OFFLINE.
default CompletableFuture<TagResourceResponse>	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
default CompletableFuture<TagResourceResponse>	tagResource(TagResourceRequest tagResourceRequest) Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
default CompletableFuture<TestIdentityProviderResponse>	testIdentityProvider(Consumer<TestIdentityProviderRequest.Builder> testIdentityProviderRequest) If the IdentityProviderType of the server is API_Gateway, tests whether your API Gateway is set up successfully.
default CompletableFuture<TestIdentityProviderResponse>	testIdentityProvider(TestIdentityProviderRequest testIdentityProviderRequest) If the IdentityProviderType of the server is API_Gateway, tests whether your API Gateway is set up successfully.
default CompletableFuture<UntagResourceResponse>	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
default CompletableFuture<UntagResourceResponse>	untagResource(UntagResourceRequest untagResourceRequest) Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
default CompletableFuture<UpdateServerResponse>	updateServer(Consumer<UpdateServerRequest.Builder> updateServerRequest) Updates the server properties after that server has been created.
default CompletableFuture<UpdateServerResponse>	updateServer(UpdateServerRequest updateServerRequest) Updates the server properties after that server has been created.
default CompletableFuture<UpdateUserResponse>	updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) Assigns new properties to a user.
default CompletableFuture<UpdateUserResponse>	updateUser(UpdateUserRequest updateUserRequest) Assigns new properties to a user.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static TransferAsyncClient create()

Create a TransferAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static TransferAsyncClientBuilder builder()

Create a builder that can be used to configure and create a TransferAsyncClient.

createServer

default CompletableFuture<CreateServerResponse> createServer(CreateServerRequest createServerRequest)

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.

Parameters:

createServerRequest -

Returns:

A Java Future containing the result of the CreateServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

createServer

default CompletableFuture<CreateServerResponse> createServer(Consumer<CreateServerRequest.Builder> createServerRequest)

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.

This is a convenience which creates an instance of the CreateServerRequest.Builder avoiding the need to create one manually via CreateServerRequest.builder()

Parameters:

createServerRequest - A Consumer that will call methods on CreateServerRequest.Builder to create a request.

Returns:

A Java Future containing the result of the CreateServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

createUser

default CompletableFuture<CreateUserResponse> createUser(CreateUserRequest createUserRequest)

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.

Parameters:

createUserRequest -

Returns:

A Java Future containing the result of the CreateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceExistsException The requested resource does not exist.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

createUser

default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest)

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.

This is a convenience which creates an instance of the CreateUserRequest.Builder avoiding the need to create one manually via CreateUserRequest.builder()

Parameters:

createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request.

Returns:

A Java Future containing the result of the CreateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceExistsException The requested resource does not exist.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteServer

default CompletableFuture<DeleteServerResponse> deleteServer(DeleteServerRequest deleteServerRequest)

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.

Parameters:

deleteServerRequest -

Returns:

A Java Future containing the result of the DeleteServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteServer

default CompletableFuture<DeleteServerResponse> deleteServer(Consumer<DeleteServerRequest.Builder> deleteServerRequest)

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.

This is a convenience which creates an instance of the DeleteServerRequest.Builder avoiding the need to create one manually via DeleteServerRequest.builder()

Parameters:

deleteServerRequest - A Consumer that will call methods on DeleteServerRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DeleteServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteSshPublicKey

default CompletableFuture<DeleteSshPublicKeyResponse> deleteSshPublicKey(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest)

Deletes a user's Secure Shell (SSH) public key.

No response is returned from this call.

Parameters:

deleteSshPublicKeyRequest -

Returns:

A Java Future containing the result of the DeleteSshPublicKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteSshPublicKey

default CompletableFuture<DeleteSshPublicKeyResponse> deleteSshPublicKey(Consumer<DeleteSshPublicKeyRequest.Builder> deleteSshPublicKeyRequest)

Deletes a user's Secure Shell (SSH) public key.

No response is returned from this call.

This is a convenience which creates an instance of the DeleteSshPublicKeyRequest.Builder avoiding the need to create one manually via DeleteSshPublicKeyRequest.builder()

Parameters:

deleteSshPublicKeyRequest - A Consumer that will call methods on DeleteSshPublicKeyRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DeleteSshPublicKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteUser

default CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest deleteUserRequest)

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.

Parameters:

deleteUserRequest -

Returns:

A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteUser

default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)

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.

This is a convenience which creates an instance of the DeleteUserRequest.Builder avoiding the need to create one manually via DeleteUserRequest.builder()

Parameters:

deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeServer

default CompletableFuture<DescribeServerResponse> describeServer(DescribeServerRequest describeServerRequest)

Describes the server that you specify by passing the ServerId parameter.

The response contains a description of the server's properties.

Parameters:

describeServerRequest -

Returns:

A Java Future containing the result of the DescribeServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeServer

default CompletableFuture<DescribeServerResponse> describeServer(Consumer<DescribeServerRequest.Builder> describeServerRequest)

Describes the server that you specify by passing the ServerId parameter.

The response contains a description of the server's properties.

This is a convenience which creates an instance of the DescribeServerRequest.Builder avoiding the need to create one manually via DescribeServerRequest.builder()

Parameters:

describeServerRequest - A Consumer that will call methods on DescribeServerRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DescribeServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeUser

default CompletableFuture<DescribeUserResponse> describeUser(DescribeUserRequest describeUserRequest)

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.

Parameters:

describeUserRequest -

Returns:

A Java Future containing the result of the DescribeUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeUser

default CompletableFuture<DescribeUserResponse> describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)

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.

This is a convenience which creates an instance of the DescribeUserRequest.Builder avoiding the need to create one manually via DescribeUserRequest.builder()

Parameters:

describeUserRequest - A Consumer that will call methods on DescribeUserRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DescribeUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

importSshPublicKey

default CompletableFuture<ImportSshPublicKeyResponse> importSshPublicKey(ImportSshPublicKeyRequest importSshPublicKeyRequest)

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.

Parameters:

importSshPublicKeyRequest -

Returns:

A Java Future containing the result of the ImportSshPublicKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceExistsException The requested resource does not exist.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

importSshPublicKey

default CompletableFuture<ImportSshPublicKeyResponse> importSshPublicKey(Consumer<ImportSshPublicKeyRequest.Builder> importSshPublicKeyRequest)

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.

This is a convenience which creates an instance of the ImportSshPublicKeyRequest.Builder avoiding the need to create one manually via ImportSshPublicKeyRequest.builder()

Parameters:

importSshPublicKeyRequest - A Consumer that will call methods on ImportSshPublicKeyRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ImportSshPublicKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceExistsException The requested resource does not exist.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listServers

default CompletableFuture<ListServersResponse> listServers(ListServersRequest listServersRequest)

Lists the Secure File Transfer Protocol (SFTP) 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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidNextTokenException The NextToken parameter that was passed is invalid.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listServers

default CompletableFuture<ListServersResponse> listServers(Consumer<ListServersRequest.Builder> listServersRequest)

Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.

This is a convenience which creates an instance of the ListServersRequest.Builder avoiding the need to create one manually via ListServersRequest.builder()

Parameters:

listServersRequest - A Consumer that will call methods on ListServersRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListServers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidNextTokenException The NextToken parameter that was passed is invalid.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listServers

default CompletableFuture<ListServersResponse> listServers()

Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.

Returns:

A Java Future containing the result of the ListServers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidNextTokenException The NextToken parameter that was passed is invalid.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listTagsForResource

default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidNextTokenException The NextToken parameter that was passed is invalid.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listTagsForResource

default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidNextTokenException The NextToken parameter that was passed is invalid.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listUsers

default CompletableFuture<ListUsersResponse> listUsers(ListUsersRequest listUsersRequest)

Lists the users for the 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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidNextTokenException The NextToken parameter that was passed is invalid.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listUsers

default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)

Lists the users for the server that you specify by passing the ServerId parameter.

This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to create one manually via ListUsersRequest.builder()

Parameters:

listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidNextTokenException The NextToken parameter that was passed is invalid.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

startServer

default CompletableFuture<StartServerResponse> startServer(StartServerRequest startServerRequest)

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.

Parameters:

startServerRequest -

Returns:

A Java Future containing the result of the StartServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

startServer

default CompletableFuture<StartServerResponse> startServer(Consumer<StartServerRequest.Builder> startServerRequest)

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.

This is a convenience which creates an instance of the StartServerRequest.Builder avoiding the need to create one manually via StartServerRequest.builder()

Parameters:

startServerRequest - A Consumer that will call methods on StartServerRequest.Builder to create a request.

Returns:

A Java Future containing the result of the StartServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

stopServer

default CompletableFuture<StopServerResponse> stopServer(StopServerRequest stopServerRequest)

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.

Parameters:

stopServerRequest -

Returns:

A Java Future containing the result of the StopServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

stopServer

default CompletableFuture<StopServerResponse> stopServer(Consumer<StopServerRequest.Builder> stopServerRequest)

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.

This is a convenience which creates an instance of the StopServerRequest.Builder avoiding the need to create one manually via StopServerRequest.builder()

Parameters:

stopServerRequest - A Consumer that will call methods on StopServerRequest.Builder to create a request.

Returns:

A Java Future containing the result of the StopServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

tagResource

default CompletableFuture<TagResourceResponse> tagResource(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

tagResource

default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> 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.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

testIdentityProvider

default CompletableFuture<TestIdentityProviderResponse> testIdentityProvider(TestIdentityProviderRequest testIdentityProviderRequest)

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.

Parameters:

testIdentityProviderRequest -

Returns:

A Java Future containing the result of the TestIdentityProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

testIdentityProvider

default CompletableFuture<TestIdentityProviderResponse> testIdentityProvider(Consumer<TestIdentityProviderRequest.Builder> testIdentityProviderRequest)

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.

This is a convenience which creates an instance of the TestIdentityProviderRequest.Builder avoiding the need to create one manually via TestIdentityProviderRequest.builder()

Parameters:

testIdentityProviderRequest - A Consumer that will call methods on TestIdentityProviderRequest.Builder to create a request.

Returns:

A Java Future containing the result of the TestIdentityProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

untagResource

default CompletableFuture<UntagResourceResponse> untagResource(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

untagResource

default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> 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.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateServer

default CompletableFuture<UpdateServerResponse> updateServer(UpdateServerRequest updateServerRequest)

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.

Parameters:

updateServerRequest -

Returns:

A Java Future containing the result of the UpdateServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateServer

default CompletableFuture<UpdateServerResponse> updateServer(Consumer<UpdateServerRequest.Builder> updateServerRequest)

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.

This is a convenience which creates an instance of the UpdateServerRequest.Builder avoiding the need to create one manually via UpdateServerRequest.builder()

Parameters:

updateServerRequest - A Consumer that will call methods on UpdateServerRequest.Builder to create a request.

Returns:

A Java Future containing the result of the UpdateServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateUser

default CompletableFuture<UpdateUserResponse> updateUser(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateUser

default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> 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.

This is a convenience which creates an instance of the UpdateUserRequest.Builder avoiding the need to create one manually via UpdateUserRequest.builder()

Parameters:

updateUserRequest - A Consumer that will call methods on UpdateUserRequest.Builder to create a request.

Returns:

A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceUnavailableException The request has failed because the AWS Transfer for SFTP service is not available.
• InternalServiceErrorException This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
• InvalidRequestException This exception is thrown when the client submits a malformed request.
• ResourceNotFoundException This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation