Interface TransferAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface TransferAsyncClient extends AwsClient
Service client for accessing AWS Transfer asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS. Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3. Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning, and archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and set up.

  • Field Details

  • Method Details

    • createAccess

      default CompletableFuture<CreateAccessResponse> createAccess(CreateAccessRequest createAccessRequest)

      Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability.

      Parameters:
      createAccessRequest -
      Returns:
      A Java Future containing the result of the CreateAccess operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • 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:

    • createAccess

      default CompletableFuture<CreateAccessResponse> createAccess(Consumer<CreateAccessRequest.Builder> createAccessRequest)

      Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability.


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

      Parameters:
      createAccessRequest - A Consumer that will call methods on CreateAccessRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAccess operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • 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:

    • createAgreement

      default CompletableFuture<CreateAgreementResponse> createAgreement(CreateAgreementRequest createAgreementRequest)

      Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.

      The partner is identified with the PartnerProfileId, and the AS2 process is identified with the LocalProfileId.

      Specify either BaseDirectory or CustomDirectories, but not both. Specifying both causes the command to fail.

      Parameters:
      createAgreementRequest -
      Returns:
      A Java Future containing the result of the CreateAgreement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • 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:

    • createAgreement

      default CompletableFuture<CreateAgreementResponse> createAgreement(Consumer<CreateAgreementRequest.Builder> createAgreementRequest)

      Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.

      The partner is identified with the PartnerProfileId, and the AS2 process is identified with the LocalProfileId.

      Specify either BaseDirectory or CustomDirectories, but not both. Specifying both causes the command to fail.


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

      Parameters:
      createAgreementRequest - A Consumer that will call methods on CreateAgreementRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAgreement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • 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:

    • createConnector

      default CompletableFuture<CreateConnectorResponse> createConnector(CreateConnectorRequest createConnectorRequest)

      Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server. For more details about connectors, see Configure AS2 connectors and Create SFTP connectors.

      You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP ( SftpConfig).

      Parameters:
      createConnectorRequest -
      Returns:
      A Java Future containing the result of the CreateConnector operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • 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:

    • createConnector

      default CompletableFuture<CreateConnectorResponse> createConnector(Consumer<CreateConnectorRequest.Builder> createConnectorRequest)

      Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server. For more details about connectors, see Configure AS2 connectors and Create SFTP connectors.

      You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP ( SftpConfig).


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

      Parameters:
      createConnectorRequest - A Consumer that will call methods on CreateConnectorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateConnector operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • 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:

    • createProfile

      default CompletableFuture<CreateProfileResponse> createProfile(CreateProfileRequest createProfileRequest)

      Creates the local or partner profile to use for AS2 transfers.

      Parameters:
      createProfileRequest -
      Returns:
      A Java Future containing the result of the CreateProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • createProfile

      default CompletableFuture<CreateProfileResponse> createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest)

      Creates the local or partner profile to use for AS2 transfers.


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

      Parameters:
      createProfileRequest - A Consumer that will call methods on CreateProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • createServer

      default CompletableFuture<CreateServerResponse> createServer(CreateServerRequest createServerRequest)

      Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.

      Parameters:
      createServerRequest -
      Returns:
      A Java Future containing the result of the CreateServer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • createServer

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

      Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.


      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • createUser

      default CompletableFuture<CreateUserResponse> createUser(CreateUserRequest createUserRequest)

      Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users.

      Parameters:
      createUserRequest -
      Returns:
      A Java Future containing the result of the CreateUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • 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:

    • createUser

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

      Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users.


      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • 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:

    • createWebApp

      default CompletableFuture<CreateWebAppResponse> createWebApp(CreateWebAppRequest createWebAppRequest)

      Creates a web app based on specified parameters, and returns the ID for the new web app.

      Parameters:
      createWebAppRequest -
      Returns:
      A Java Future containing the result of the CreateWebApp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • createWebApp

      default CompletableFuture<CreateWebAppResponse> createWebApp(Consumer<CreateWebAppRequest.Builder> createWebAppRequest)

      Creates a web app based on specified parameters, and returns the ID for the new web app.


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

      Parameters:
      createWebAppRequest - A Consumer that will call methods on CreateWebAppRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateWebApp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • createWorkflow

      default CompletableFuture<CreateWorkflowResponse> createWorkflow(CreateWorkflowRequest createWorkflowRequest)

      Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

      Parameters:
      createWorkflowRequest -
      Returns:
      A Java Future containing the result of the CreateWorkflow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • createWorkflow

      default CompletableFuture<CreateWorkflowResponse> createWorkflow(Consumer<CreateWorkflowRequest.Builder> createWorkflowRequest)

      Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.


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

      Parameters:
      createWorkflowRequest - A Consumer that will call methods on CreateWorkflowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateWorkflow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • deleteAccess

      default CompletableFuture<DeleteAccessResponse> deleteAccess(DeleteAccessRequest deleteAccessRequest)

      Allows you to delete the access specified in the ServerID and ExternalID parameters.

      Parameters:
      deleteAccessRequest -
      Returns:
      A Java Future containing the result of the DeleteAccess operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • deleteAccess

      default CompletableFuture<DeleteAccessResponse> deleteAccess(Consumer<DeleteAccessRequest.Builder> deleteAccessRequest)

      Allows you to delete the access specified in the ServerID and ExternalID parameters.


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

      Parameters:
      deleteAccessRequest - A Consumer that will call methods on DeleteAccessRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAccess operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • deleteAgreement

      default CompletableFuture<DeleteAgreementResponse> deleteAgreement(DeleteAgreementRequest deleteAgreementRequest)

      Delete the agreement that's specified in the provided AgreementId.

      Parameters:
      deleteAgreementRequest -
      Returns:
      A Java Future containing the result of the DeleteAgreement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • deleteAgreement

      default CompletableFuture<DeleteAgreementResponse> deleteAgreement(Consumer<DeleteAgreementRequest.Builder> deleteAgreementRequest)

      Delete the agreement that's specified in the provided AgreementId.


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

      Parameters:
      deleteAgreementRequest - A Consumer that will call methods on DeleteAgreementRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAgreement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • deleteCertificate

      default CompletableFuture<DeleteCertificateResponse> deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)

      Deletes the certificate that's specified in the CertificateId parameter.

      Parameters:
      deleteCertificateRequest -
      Returns:
      A Java Future containing the result of the DeleteCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • deleteCertificate

      default CompletableFuture<DeleteCertificateResponse> deleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest)

      Deletes the certificate that's specified in the CertificateId parameter.


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

      Parameters:
      deleteCertificateRequest - A Consumer that will call methods on DeleteCertificateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • deleteConnector

      default CompletableFuture<DeleteConnectorResponse> deleteConnector(DeleteConnectorRequest deleteConnectorRequest)

      Deletes the connector that's specified in the provided ConnectorId.

      Parameters:
      deleteConnectorRequest -
      Returns:
      A Java Future containing the result of the DeleteConnector operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • deleteConnector

      default CompletableFuture<DeleteConnectorResponse> deleteConnector(Consumer<DeleteConnectorRequest.Builder> deleteConnectorRequest)

      Deletes the connector that's specified in the provided ConnectorId.


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

      Parameters:
      deleteConnectorRequest - A Consumer that will call methods on DeleteConnectorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteConnector operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • deleteHostKey

      default CompletableFuture<DeleteHostKeyResponse> deleteHostKey(DeleteHostKeyRequest deleteHostKeyRequest)

      Deletes the host key that's specified in the HostKeyId parameter.

      Parameters:
      deleteHostKeyRequest -
      Returns:
      A Java Future containing the result of the DeleteHostKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • deleteHostKey

      default CompletableFuture<DeleteHostKeyResponse> deleteHostKey(Consumer<DeleteHostKeyRequest.Builder> deleteHostKeyRequest)

      Deletes the host key that's specified in the HostKeyId parameter.


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

      Parameters:
      deleteHostKeyRequest - A Consumer that will call methods on DeleteHostKeyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteHostKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • deleteProfile

      default CompletableFuture<DeleteProfileResponse> deleteProfile(DeleteProfileRequest deleteProfileRequest)

      Deletes the profile that's specified in the ProfileId parameter.

      Parameters:
      deleteProfileRequest -
      Returns:
      A Java Future containing the result of the DeleteProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • deleteProfile

      default CompletableFuture<DeleteProfileResponse> deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest)

      Deletes the profile that's specified in the ProfileId parameter.


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

      Parameters:
      deleteProfileRequest - A Consumer that will call methods on DeleteProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • deleteServer

      default CompletableFuture<DeleteServerResponse> deleteServer(DeleteServerRequest deleteServerRequest)

      Deletes the file transfer protocol-enabled server that you specify.

      No response returns from this operation.

      Parameters:
      deleteServerRequest -
      Returns:
      A Java Future containing the result of the DeleteServer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • deleteServer

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

      Deletes the file transfer protocol-enabled server that you specify.

      No response returns from this operation.


      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • deleteSshPublicKey

      default CompletableFuture<DeleteSshPublicKeyResponse> deleteSshPublicKey(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest)

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

      Parameters:
      deleteSshPublicKeyRequest -
      Returns:
      A Java Future containing the result of the DeleteSshPublicKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • deleteSshPublicKey

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

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


      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • deleteUser

      default CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest deleteUserRequest)

      Deletes the user belonging to a file transfer protocol-enabled server you specify.

      No response returns from this operation.

      When you delete a user from a server, the user's information is lost.

      Parameters:
      deleteUserRequest -
      Returns:
      A Java Future containing the result of the DeleteUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • deleteUser

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

      Deletes the user belonging to a file transfer protocol-enabled server you specify.

      No response returns from this operation.

      When you delete a user from a server, the user's information is lost.


      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • deleteWebApp

      default CompletableFuture<DeleteWebAppResponse> deleteWebApp(DeleteWebAppRequest deleteWebAppRequest)

      Deletes the specified web app.

      Parameters:
      deleteWebAppRequest -
      Returns:
      A Java Future containing the result of the DeleteWebApp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • deleteWebApp

      default CompletableFuture<DeleteWebAppResponse> deleteWebApp(Consumer<DeleteWebAppRequest.Builder> deleteWebAppRequest)

      Deletes the specified web app.


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

      Parameters:
      deleteWebAppRequest - A Consumer that will call methods on DeleteWebAppRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteWebApp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • deleteWebAppCustomization

      default CompletableFuture<DeleteWebAppCustomizationResponse> deleteWebAppCustomization(DeleteWebAppCustomizationRequest deleteWebAppCustomizationRequest)

      Deletes the WebAppCustomization object that corresponds to the web app ID specified.

      Parameters:
      deleteWebAppCustomizationRequest -
      Returns:
      A Java Future containing the result of the DeleteWebAppCustomization operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException This exception is thrown when the UpdateServer is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • deleteWebAppCustomization

      default CompletableFuture<DeleteWebAppCustomizationResponse> deleteWebAppCustomization(Consumer<DeleteWebAppCustomizationRequest.Builder> deleteWebAppCustomizationRequest)

      Deletes the WebAppCustomization object that corresponds to the web app ID specified.


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

      Parameters:
      deleteWebAppCustomizationRequest - A Consumer that will call methods on DeleteWebAppCustomizationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteWebAppCustomization operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException This exception is thrown when the UpdateServer is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • deleteWorkflow

      default CompletableFuture<DeleteWorkflowResponse> deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest)

      Deletes the specified workflow.

      Parameters:
      deleteWorkflowRequest -
      Returns:
      A Java Future containing the result of the DeleteWorkflow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • deleteWorkflow

      default CompletableFuture<DeleteWorkflowResponse> deleteWorkflow(Consumer<DeleteWorkflowRequest.Builder> deleteWorkflowRequest)

      Deletes the specified workflow.


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

      Parameters:
      deleteWorkflowRequest - A Consumer that will call methods on DeleteWorkflowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteWorkflow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • describeAccess

      default CompletableFuture<DescribeAccessResponse> describeAccess(DescribeAccessRequest describeAccessRequest)

      Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalId.

      The response from this call returns the properties of the access that is associated with the ServerId value that was specified.

      Parameters:
      describeAccessRequest -
      Returns:
      A Java Future containing the result of the DescribeAccess operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeAccess

      default CompletableFuture<DescribeAccessResponse> describeAccess(Consumer<DescribeAccessRequest.Builder> describeAccessRequest)

      Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalId.

      The response from this call returns the properties of the access that is associated with the ServerId value that was specified.


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

      Parameters:
      describeAccessRequest - A Consumer that will call methods on DescribeAccessRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAccess operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeAgreement

      default CompletableFuture<DescribeAgreementResponse> describeAgreement(DescribeAgreementRequest describeAgreementRequest)

      Describes the agreement that's identified by the AgreementId.

      Parameters:
      describeAgreementRequest -
      Returns:
      A Java Future containing the result of the DescribeAgreement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeAgreement

      default CompletableFuture<DescribeAgreementResponse> describeAgreement(Consumer<DescribeAgreementRequest.Builder> describeAgreementRequest)

      Describes the agreement that's identified by the AgreementId.


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

      Parameters:
      describeAgreementRequest - A Consumer that will call methods on DescribeAgreementRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAgreement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeCertificate

      default CompletableFuture<DescribeCertificateResponse> describeCertificate(DescribeCertificateRequest describeCertificateRequest)

      Describes the certificate that's identified by the CertificateId.

      Parameters:
      describeCertificateRequest -
      Returns:
      A Java Future containing the result of the DescribeCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeCertificate

      default CompletableFuture<DescribeCertificateResponse> describeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest)

      Describes the certificate that's identified by the CertificateId.


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

      Parameters:
      describeCertificateRequest - A Consumer that will call methods on DescribeCertificateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeConnector

      default CompletableFuture<DescribeConnectorResponse> describeConnector(DescribeConnectorRequest describeConnectorRequest)

      Describes the connector that's identified by the ConnectorId.

      Parameters:
      describeConnectorRequest -
      Returns:
      A Java Future containing the result of the DescribeConnector operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeConnector

      default CompletableFuture<DescribeConnectorResponse> describeConnector(Consumer<DescribeConnectorRequest.Builder> describeConnectorRequest)

      Describes the connector that's identified by the ConnectorId.


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

      Parameters:
      describeConnectorRequest - A Consumer that will call methods on DescribeConnectorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeConnector operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeExecution

      default CompletableFuture<DescribeExecutionResponse> describeExecution(DescribeExecutionRequest describeExecutionRequest)

      You can use DescribeExecution to check the details of the execution of the specified workflow.

      This API call only returns details for in-progress workflows.

      If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a ResourceNotFound exception.

      Parameters:
      describeExecutionRequest -
      Returns:
      A Java Future containing the result of the DescribeExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeExecution

      default CompletableFuture<DescribeExecutionResponse> describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest)

      You can use DescribeExecution to check the details of the execution of the specified workflow.

      This API call only returns details for in-progress workflows.

      If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a ResourceNotFound exception.


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

      Parameters:
      describeExecutionRequest - A Consumer that will call methods on DescribeExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeHostKey

      default CompletableFuture<DescribeHostKeyResponse> describeHostKey(DescribeHostKeyRequest describeHostKeyRequest)

      Returns the details of the host key that's specified by the HostKeyId and ServerId.

      Parameters:
      describeHostKeyRequest -
      Returns:
      A Java Future containing the result of the DescribeHostKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeHostKey

      default CompletableFuture<DescribeHostKeyResponse> describeHostKey(Consumer<DescribeHostKeyRequest.Builder> describeHostKeyRequest)

      Returns the details of the host key that's specified by the HostKeyId and ServerId.


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

      Parameters:
      describeHostKeyRequest - A Consumer that will call methods on DescribeHostKeyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeHostKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeProfile

      default CompletableFuture<DescribeProfileResponse> describeProfile(DescribeProfileRequest describeProfileRequest)

      Returns the details of the profile that's specified by the ProfileId.

      Parameters:
      describeProfileRequest -
      Returns:
      A Java Future containing the result of the DescribeProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeProfile

      default CompletableFuture<DescribeProfileResponse> describeProfile(Consumer<DescribeProfileRequest.Builder> describeProfileRequest)

      Returns the details of the profile that's specified by the ProfileId.


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

      Parameters:
      describeProfileRequest - A Consumer that will call methods on DescribeProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeSecurityPolicy

      default CompletableFuture<DescribeSecurityPolicyResponse> describeSecurityPolicy(DescribeSecurityPolicyRequest describeSecurityPolicyRequest)

      Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.

      Parameters:
      describeSecurityPolicyRequest -
      Returns:
      A Java Future containing the result of the DescribeSecurityPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeSecurityPolicy

      default CompletableFuture<DescribeSecurityPolicyResponse> describeSecurityPolicy(Consumer<DescribeSecurityPolicyRequest.Builder> describeSecurityPolicyRequest)

      Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.


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

      Parameters:
      describeSecurityPolicyRequest - A Consumer that will call methods on DescribeSecurityPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeSecurityPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeServer

      default CompletableFuture<DescribeServerResponse> describeServer(DescribeServerRequest describeServerRequest)

      Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

      The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.

      Parameters:
      describeServerRequest -
      Returns:
      A Java Future containing the result of the DescribeServer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeServer

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

      Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

      The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.


      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeUser

      default CompletableFuture<DescribeUserResponse> describeUser(DescribeUserRequest describeUserRequest)

      Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property.

      The response from this call returns the properties of the user associated with the ServerId value that was specified.

      Parameters:
      describeUserRequest -
      Returns:
      A Java Future containing the result of the DescribeUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeUser

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

      Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property.

      The response from this call returns the properties of the user associated with the ServerId value that was specified.


      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeWebApp

      default CompletableFuture<DescribeWebAppResponse> describeWebApp(DescribeWebAppRequest describeWebAppRequest)

      Describes the web app that's identified by WebAppId.

      Parameters:
      describeWebAppRequest -
      Returns:
      A Java Future containing the result of the DescribeWebApp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • describeWebApp

      default CompletableFuture<DescribeWebAppResponse> describeWebApp(Consumer<DescribeWebAppRequest.Builder> describeWebAppRequest)

      Describes the web app that's identified by WebAppId.


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

      Parameters:
      describeWebAppRequest - A Consumer that will call methods on DescribeWebAppRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeWebApp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • describeWebAppCustomization

      default CompletableFuture<DescribeWebAppCustomizationResponse> describeWebAppCustomization(DescribeWebAppCustomizationRequest describeWebAppCustomizationRequest)

      Describes the web app customization object that's identified by WebAppId.

      Parameters:
      describeWebAppCustomizationRequest -
      Returns:
      A Java Future containing the result of the DescribeWebAppCustomization operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • describeWebAppCustomization

      default CompletableFuture<DescribeWebAppCustomizationResponse> describeWebAppCustomization(Consumer<DescribeWebAppCustomizationRequest.Builder> describeWebAppCustomizationRequest)

      Describes the web app customization object that's identified by WebAppId.


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

      Parameters:
      describeWebAppCustomizationRequest - A Consumer that will call methods on DescribeWebAppCustomizationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeWebAppCustomization operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • describeWorkflow

      default CompletableFuture<DescribeWorkflowResponse> describeWorkflow(DescribeWorkflowRequest describeWorkflowRequest)

      Describes the specified workflow.

      Parameters:
      describeWorkflowRequest -
      Returns:
      A Java Future containing the result of the DescribeWorkflow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • describeWorkflow

      default CompletableFuture<DescribeWorkflowResponse> describeWorkflow(Consumer<DescribeWorkflowRequest.Builder> describeWorkflowRequest)

      Describes the specified workflow.


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

      Parameters:
      describeWorkflowRequest - A Consumer that will call methods on DescribeWorkflowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeWorkflow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • importCertificate

      default CompletableFuture<ImportCertificateResponse> importCertificate(ImportCertificateRequest importCertificateRequest)

      Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

      You can import both the certificate and its chain in the Certificate parameter.

      If you use the Certificate parameter to upload both the certificate and its chain, don't use the CertificateChain parameter.

      Parameters:
      importCertificateRequest -
      Returns:
      A Java Future containing the result of the ImportCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • importCertificate

      default CompletableFuture<ImportCertificateResponse> importCertificate(Consumer<ImportCertificateRequest.Builder> importCertificateRequest)

      Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

      You can import both the certificate and its chain in the Certificate parameter.

      If you use the Certificate parameter to upload both the certificate and its chain, don't use the CertificateChain parameter.


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

      Parameters:
      importCertificateRequest - A Consumer that will call methods on ImportCertificateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ImportCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • importHostKey

      default CompletableFuture<ImportHostKeyResponse> importHostKey(ImportHostKeyRequest importHostKeyRequest)

      Adds a host key to the server that's specified by the ServerId parameter.

      Parameters:
      importHostKeyRequest -
      Returns:
      A Java Future containing the result of the ImportHostKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • 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:

    • importHostKey

      default CompletableFuture<ImportHostKeyResponse> importHostKey(Consumer<ImportHostKeyRequest.Builder> importHostKeyRequest)

      Adds a host key to the server that's specified by the ServerId parameter.


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

      Parameters:
      importHostKeyRequest - A Consumer that will call methods on ImportHostKeyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ImportHostKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • 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:

    • importSshPublicKey

      default CompletableFuture<ImportSshPublicKeyResponse> importSshPublicKey(ImportSshPublicKeyRequest importSshPublicKeyRequest)

      Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId.

      The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.

      Parameters:
      importSshPublicKeyRequest -
      Returns:
      A Java Future containing the result of the ImportSshPublicKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • 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:

    • importSshPublicKey

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

      Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId.

      The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.


      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • 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:

    • listAccesses

      default CompletableFuture<ListAccessesResponse> listAccesses(ListAccessesRequest listAccessesRequest)

      Lists the details for all the accesses you have on your server.

      Parameters:
      listAccessesRequest -
      Returns:
      A Java Future containing the result of the ListAccesses operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listAccesses

      default CompletableFuture<ListAccessesResponse> listAccesses(Consumer<ListAccessesRequest.Builder> listAccessesRequest)

      Lists the details for all the accesses you have on your server.


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

      Parameters:
      listAccessesRequest - A Consumer that will call methods on ListAccessesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAccesses operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listAccessesPaginator

      default ListAccessesPublisher listAccessesPaginator(ListAccessesRequest listAccessesRequest)

      This is a variant of listAccesses(software.amazon.awssdk.services.transfer.model.ListAccessesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListAccessesPublisher publisher = client.listAccessesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListAccessesPublisher publisher = client.listAccessesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListAccessesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListAccessesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAccesses(software.amazon.awssdk.services.transfer.model.ListAccessesRequest) operation.

      Parameters:
      listAccessesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listAccessesPaginator

      default ListAccessesPublisher listAccessesPaginator(Consumer<ListAccessesRequest.Builder> listAccessesRequest)

      This is a variant of listAccesses(software.amazon.awssdk.services.transfer.model.ListAccessesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListAccessesPublisher publisher = client.listAccessesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListAccessesPublisher publisher = client.listAccessesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListAccessesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListAccessesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAccesses(software.amazon.awssdk.services.transfer.model.ListAccessesRequest) operation.


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

      Parameters:
      listAccessesRequest - A Consumer that will call methods on ListAccessesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listAgreements

      default CompletableFuture<ListAgreementsResponse> listAgreements(ListAgreementsRequest listAgreementsRequest)

      Returns a list of the agreements for the server that's identified by the ServerId that you supply. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing agreements from where you left off.

      Parameters:
      listAgreementsRequest -
      Returns:
      A Java Future containing the result of the ListAgreements operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listAgreements

      default CompletableFuture<ListAgreementsResponse> listAgreements(Consumer<ListAgreementsRequest.Builder> listAgreementsRequest)

      Returns a list of the agreements for the server that's identified by the ServerId that you supply. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing agreements from where you left off.


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

      Parameters:
      listAgreementsRequest - A Consumer that will call methods on ListAgreementsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAgreements operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listAgreementsPaginator

      default ListAgreementsPublisher listAgreementsPaginator(ListAgreementsRequest listAgreementsRequest)

      This is a variant of listAgreements(software.amazon.awssdk.services.transfer.model.ListAgreementsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListAgreementsPublisher publisher = client.listAgreementsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListAgreementsPublisher publisher = client.listAgreementsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListAgreementsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListAgreementsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAgreements(software.amazon.awssdk.services.transfer.model.ListAgreementsRequest) operation.

      Parameters:
      listAgreementsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listAgreementsPaginator

      default ListAgreementsPublisher listAgreementsPaginator(Consumer<ListAgreementsRequest.Builder> listAgreementsRequest)

      This is a variant of listAgreements(software.amazon.awssdk.services.transfer.model.ListAgreementsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListAgreementsPublisher publisher = client.listAgreementsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListAgreementsPublisher publisher = client.listAgreementsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListAgreementsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListAgreementsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAgreements(software.amazon.awssdk.services.transfer.model.ListAgreementsRequest) operation.


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

      Parameters:
      listAgreementsRequest - A Consumer that will call methods on ListAgreementsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listCertificates

      default CompletableFuture<ListCertificatesResponse> listCertificates(ListCertificatesRequest listCertificatesRequest)

      Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for the NextToken parameter, you can supply that value to continue listing certificates from where you left off.

      Parameters:
      listCertificatesRequest -
      Returns:
      A Java Future containing the result of the ListCertificates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listCertificates

      default CompletableFuture<ListCertificatesResponse> listCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)

      Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for the NextToken parameter, you can supply that value to continue listing certificates from where you left off.


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

      Parameters:
      listCertificatesRequest - A Consumer that will call methods on ListCertificatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListCertificates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listCertificatesPaginator

      default ListCertificatesPublisher listCertificatesPaginator(ListCertificatesRequest listCertificatesRequest)

      This is a variant of listCertificates(software.amazon.awssdk.services.transfer.model.ListCertificatesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListCertificatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListCertificatesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCertificates(software.amazon.awssdk.services.transfer.model.ListCertificatesRequest) operation.

      Parameters:
      listCertificatesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listCertificatesPaginator

      default ListCertificatesPublisher listCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)

      This is a variant of listCertificates(software.amazon.awssdk.services.transfer.model.ListCertificatesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListCertificatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListCertificatesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCertificates(software.amazon.awssdk.services.transfer.model.ListCertificatesRequest) operation.


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

      Parameters:
      listCertificatesRequest - A Consumer that will call methods on ListCertificatesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listConnectors

      default CompletableFuture<ListConnectorsResponse> listConnectors(ListConnectorsRequest listConnectorsRequest)

      Lists the connectors for the specified Region.

      Parameters:
      listConnectorsRequest -
      Returns:
      A Java Future containing the result of the ListConnectors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listConnectors

      default CompletableFuture<ListConnectorsResponse> listConnectors(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest)

      Lists the connectors for the specified Region.


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

      Parameters:
      listConnectorsRequest - A Consumer that will call methods on ListConnectorsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListConnectors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listConnectorsPaginator

      default ListConnectorsPublisher listConnectorsPaginator(ListConnectorsRequest listConnectorsRequest)

      This is a variant of listConnectors(software.amazon.awssdk.services.transfer.model.ListConnectorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListConnectorsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListConnectorsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listConnectors(software.amazon.awssdk.services.transfer.model.ListConnectorsRequest) operation.

      Parameters:
      listConnectorsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listConnectorsPaginator

      default ListConnectorsPublisher listConnectorsPaginator(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest)

      This is a variant of listConnectors(software.amazon.awssdk.services.transfer.model.ListConnectorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListConnectorsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListConnectorsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listConnectors(software.amazon.awssdk.services.transfer.model.ListConnectorsRequest) operation.


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

      Parameters:
      listConnectorsRequest - A Consumer that will call methods on ListConnectorsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listExecutions

      default CompletableFuture<ListExecutionsResponse> listExecutions(ListExecutionsRequest listExecutionsRequest)

      Lists all in-progress executions for the specified workflow.

      If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.

      Parameters:
      listExecutionsRequest -
      Returns:
      A Java Future containing the result of the ListExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listExecutions

      default CompletableFuture<ListExecutionsResponse> listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)

      Lists all in-progress executions for the specified workflow.

      If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.


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

      Parameters:
      listExecutionsRequest - A Consumer that will call methods on ListExecutionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listExecutionsPaginator

      default ListExecutionsPublisher listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)

      This is a variant of listExecutions(software.amazon.awssdk.services.transfer.model.ListExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listExecutions(software.amazon.awssdk.services.transfer.model.ListExecutionsRequest) operation.

      Parameters:
      listExecutionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listExecutionsPaginator

      default ListExecutionsPublisher listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)

      This is a variant of listExecutions(software.amazon.awssdk.services.transfer.model.ListExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listExecutions(software.amazon.awssdk.services.transfer.model.ListExecutionsRequest) operation.


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

      Parameters:
      listExecutionsRequest - A Consumer that will call methods on ListExecutionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listFileTransferResults

      default CompletableFuture<ListFileTransferResultsResponse> listFileTransferResults(ListFileTransferResultsRequest listFileTransferResultsRequest)

      Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation. You specify the file transfer by providing its ConnectorId and its TransferId.

      File transfer results are available up to 7 days after an operation has been requested.

      Parameters:
      listFileTransferResultsRequest -
      Returns:
      A Java Future containing the result of the ListFileTransferResults operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • listFileTransferResults

      default CompletableFuture<ListFileTransferResultsResponse> listFileTransferResults(Consumer<ListFileTransferResultsRequest.Builder> listFileTransferResultsRequest)

      Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation. You specify the file transfer by providing its ConnectorId and its TransferId.

      File transfer results are available up to 7 days after an operation has been requested.


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

      Parameters:
      listFileTransferResultsRequest - A Consumer that will call methods on ListFileTransferResultsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFileTransferResults operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • listFileTransferResultsPaginator

      default ListFileTransferResultsPublisher listFileTransferResultsPaginator(ListFileTransferResultsRequest listFileTransferResultsRequest)

      This is a variant of listFileTransferResults(software.amazon.awssdk.services.transfer.model.ListFileTransferResultsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListFileTransferResultsPublisher publisher = client.listFileTransferResultsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListFileTransferResultsPublisher publisher = client.listFileTransferResultsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListFileTransferResultsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListFileTransferResultsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listFileTransferResults(software.amazon.awssdk.services.transfer.model.ListFileTransferResultsRequest) operation.

      Parameters:
      listFileTransferResultsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • listFileTransferResultsPaginator

      default ListFileTransferResultsPublisher listFileTransferResultsPaginator(Consumer<ListFileTransferResultsRequest.Builder> listFileTransferResultsRequest)

      This is a variant of listFileTransferResults(software.amazon.awssdk.services.transfer.model.ListFileTransferResultsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListFileTransferResultsPublisher publisher = client.listFileTransferResultsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListFileTransferResultsPublisher publisher = client.listFileTransferResultsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListFileTransferResultsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListFileTransferResultsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listFileTransferResults(software.amazon.awssdk.services.transfer.model.ListFileTransferResultsRequest) operation.


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

      Parameters:
      listFileTransferResultsRequest - A Consumer that will call methods on ListFileTransferResultsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • listHostKeys

      default CompletableFuture<ListHostKeysResponse> listHostKeys(ListHostKeysRequest listHostKeysRequest)

      Returns a list of host keys for the server that's specified by the ServerId parameter.

      Parameters:
      listHostKeysRequest -
      Returns:
      A Java Future containing the result of the ListHostKeys operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listHostKeys

      default CompletableFuture<ListHostKeysResponse> listHostKeys(Consumer<ListHostKeysRequest.Builder> listHostKeysRequest)

      Returns a list of host keys for the server that's specified by the ServerId parameter.


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

      Parameters:
      listHostKeysRequest - A Consumer that will call methods on ListHostKeysRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListHostKeys operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listProfiles

      default CompletableFuture<ListProfilesResponse> listProfiles(ListProfilesRequest listProfilesRequest)

      Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing profiles from where you left off.

      Parameters:
      listProfilesRequest -
      Returns:
      A Java Future containing the result of the ListProfiles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listProfiles

      default CompletableFuture<ListProfilesResponse> listProfiles(Consumer<ListProfilesRequest.Builder> listProfilesRequest)

      Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing profiles from where you left off.


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

      Parameters:
      listProfilesRequest - A Consumer that will call methods on ListProfilesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListProfiles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listProfilesPaginator

      default ListProfilesPublisher listProfilesPaginator(ListProfilesRequest listProfilesRequest)

      This is a variant of listProfiles(software.amazon.awssdk.services.transfer.model.ListProfilesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListProfilesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListProfilesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listProfiles(software.amazon.awssdk.services.transfer.model.ListProfilesRequest) operation.

      Parameters:
      listProfilesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listProfilesPaginator

      default ListProfilesPublisher listProfilesPaginator(Consumer<ListProfilesRequest.Builder> listProfilesRequest)

      This is a variant of listProfiles(software.amazon.awssdk.services.transfer.model.ListProfilesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListProfilesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListProfilesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listProfiles(software.amazon.awssdk.services.transfer.model.ListProfilesRequest) operation.


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

      Parameters:
      listProfilesRequest - A Consumer that will call methods on ListProfilesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listSecurityPolicies

      default CompletableFuture<ListSecurityPoliciesResponse> listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest)

      Lists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.

      Parameters:
      listSecurityPoliciesRequest -
      Returns:
      A Java Future containing the result of the ListSecurityPolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listSecurityPolicies

      default CompletableFuture<ListSecurityPoliciesResponse> listSecurityPolicies(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)

      Lists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.


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

      Parameters:
      listSecurityPoliciesRequest - A Consumer that will call methods on ListSecurityPoliciesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSecurityPolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listSecurityPoliciesPaginator

      default ListSecurityPoliciesPublisher listSecurityPoliciesPaginator(ListSecurityPoliciesRequest listSecurityPoliciesRequest)

      This is a variant of listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesPublisher publisher = client.listSecurityPoliciesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesPublisher publisher = client.listSecurityPoliciesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest) operation.

      Parameters:
      listSecurityPoliciesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listSecurityPoliciesPaginator

      default ListSecurityPoliciesPublisher listSecurityPoliciesPaginator(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)

      This is a variant of listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesPublisher publisher = client.listSecurityPoliciesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesPublisher publisher = client.listSecurityPoliciesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest) operation.


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

      Parameters:
      listSecurityPoliciesRequest - A Consumer that will call methods on ListSecurityPoliciesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listServers

      default CompletableFuture<ListServersResponse> listServers(ListServersRequest listServersRequest)

      Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.

      Parameters:
      listServersRequest -
      Returns:
      A Java Future containing the result of the ListServers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listServers

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

      Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listServers

      default CompletableFuture<ListServersResponse> listServers()

      Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listServersPaginator

      default ListServersPublisher listServersPaginator()

      This is a variant of listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListServersPublisher publisher = client.listServersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListServersPublisher publisher = client.listServersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListServersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListServersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listServersPaginator

      default ListServersPublisher listServersPaginator(ListServersRequest listServersRequest)

      This is a variant of listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListServersPublisher publisher = client.listServersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListServersPublisher publisher = client.listServersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListServersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListServersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest) operation.

      Parameters:
      listServersRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listServersPaginator

      default ListServersPublisher listServersPaginator(Consumer<ListServersRequest.Builder> listServersRequest)

      This is a variant of listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListServersPublisher publisher = client.listServersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListServersPublisher publisher = client.listServersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListServersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListServersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest) operation.


      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 custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listTagsForResource

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

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


      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listTagsForResourcePaginator

      default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)

      This is a variant of listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListTagsForResourceResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest) operation.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listTagsForResourcePaginator

      default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      This is a variant of listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListTagsForResourceResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest) operation.


      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 custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listUsers

      default CompletableFuture<ListUsersResponse> listUsers(ListUsersRequest listUsersRequest)

      Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

      Parameters:
      listUsersRequest -
      Returns:
      A Java Future containing the result of the ListUsers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listUsers

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

      Lists the users for a file transfer protocol-enabled 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listUsersPaginator

      default ListUsersPublisher listUsersPaginator(ListUsersRequest listUsersRequest)

      This is a variant of listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListUsersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListUsersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest) operation.

      Parameters:
      listUsersRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listUsersPaginator

      default ListUsersPublisher listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)

      This is a variant of listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListUsersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListUsersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest) operation.


      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 custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listWebApps

      default CompletableFuture<ListWebAppsResponse> listWebApps(ListWebAppsRequest listWebAppsRequest)

      Lists all web apps associated with your Amazon Web Services account for your current region.

      Parameters:
      listWebAppsRequest -
      Returns:
      A Java Future containing the result of the ListWebApps operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listWebApps

      default CompletableFuture<ListWebAppsResponse> listWebApps(Consumer<ListWebAppsRequest.Builder> listWebAppsRequest)

      Lists all web apps associated with your Amazon Web Services account for your current region.


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

      Parameters:
      listWebAppsRequest - A Consumer that will call methods on ListWebAppsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListWebApps operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listWebAppsPaginator

      default ListWebAppsPublisher listWebAppsPaginator(ListWebAppsRequest listWebAppsRequest)

      This is a variant of listWebApps(software.amazon.awssdk.services.transfer.model.ListWebAppsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListWebAppsPublisher publisher = client.listWebAppsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListWebAppsPublisher publisher = client.listWebAppsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListWebAppsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListWebAppsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWebApps(software.amazon.awssdk.services.transfer.model.ListWebAppsRequest) operation.

      Parameters:
      listWebAppsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listWebAppsPaginator

      default ListWebAppsPublisher listWebAppsPaginator(Consumer<ListWebAppsRequest.Builder> listWebAppsRequest)

      This is a variant of listWebApps(software.amazon.awssdk.services.transfer.model.ListWebAppsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListWebAppsPublisher publisher = client.listWebAppsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListWebAppsPublisher publisher = client.listWebAppsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListWebAppsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListWebAppsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWebApps(software.amazon.awssdk.services.transfer.model.ListWebAppsRequest) operation.


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

      Parameters:
      listWebAppsRequest - A Consumer that will call methods on ListWebAppsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listWorkflows

      default CompletableFuture<ListWorkflowsResponse> listWorkflows(ListWorkflowsRequest listWorkflowsRequest)

      Lists all workflows associated with your Amazon Web Services account for your current region.

      Parameters:
      listWorkflowsRequest -
      Returns:
      A Java Future containing the result of the ListWorkflows operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listWorkflows

      default CompletableFuture<ListWorkflowsResponse> listWorkflows(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest)

      Lists all workflows associated with your Amazon Web Services account for your current region.


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

      Parameters:
      listWorkflowsRequest - A Consumer that will call methods on ListWorkflowsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListWorkflows operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listWorkflowsPaginator

      default ListWorkflowsPublisher listWorkflowsPaginator(ListWorkflowsRequest listWorkflowsRequest)

      This is a variant of listWorkflows(software.amazon.awssdk.services.transfer.model.ListWorkflowsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListWorkflowsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListWorkflowsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWorkflows(software.amazon.awssdk.services.transfer.model.ListWorkflowsRequest) operation.

      Parameters:
      listWorkflowsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • listWorkflowsPaginator

      default ListWorkflowsPublisher listWorkflowsPaginator(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest)

      This is a variant of listWorkflows(software.amazon.awssdk.services.transfer.model.ListWorkflowsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.transfer.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.transfer.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListWorkflowsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.transfer.model.ListWorkflowsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWorkflows(software.amazon.awssdk.services.transfer.model.ListWorkflowsRequest) operation.


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

      Parameters:
      listWorkflowsRequest - A Consumer that will call methods on ListWorkflowsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • InvalidNextTokenException The NextToken parameter that was passed is invalid.
      • 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:

    • sendWorkflowStepState

      default CompletableFuture<SendWorkflowStepStateResponse> sendWorkflowStepState(SendWorkflowStepStateRequest sendWorkflowStepStateRequest)

      Sends a callback for asynchronous custom steps.

      The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status.

      Parameters:
      sendWorkflowStepStateRequest -
      Returns:
      A Java Future containing the result of the SendWorkflowStepState operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • sendWorkflowStepState

      default CompletableFuture<SendWorkflowStepStateResponse> sendWorkflowStepState(Consumer<SendWorkflowStepStateRequest.Builder> sendWorkflowStepStateRequest)

      Sends a callback for asynchronous custom steps.

      The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status.


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

      Parameters:
      sendWorkflowStepStateRequest - A Consumer that will call methods on SendWorkflowStepStateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SendWorkflowStepState operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • startDirectoryListing

      default CompletableFuture<StartDirectoryListingResponse> startDirectoryListing(StartDirectoryListingRequest startDirectoryListingRequest)

      Retrieves a list of the contents of a directory from a remote SFTP server. You specify the connector ID, the output path, and the remote directory path. You can also specify the optional MaxItems value to control the maximum number of items that are listed from the remote directory. This API returns a list of all files and directories in the remote directory (up to the maximum value), but does not return files or folders in sub-directories. That is, it only returns a list of files and directories one-level deep.

      After you receive the listing file, you can provide the files that you want to transfer to the RetrieveFilePaths parameter of the StartFileTransfer API call.

      The naming convention for the output file is connector-ID-listing-ID.json. The output file contains the following information:

      • filePath: the complete path of a remote file, relative to the directory of the listing request for your SFTP connector on the remote server.

      • modifiedTimestamp: the last time the file was modified, in UTC time format. This field is optional. If the remote file attributes don't contain a timestamp, it is omitted from the file listing.

      • size: the size of the file, in bytes. This field is optional. If the remote file attributes don't contain a file size, it is omitted from the file listing.

      • path: the complete path of a remote directory, relative to the directory of the listing request for your SFTP connector on the remote server.

      • truncated: a flag indicating whether the list output contains all of the items contained in the remote directory or not. If your Truncated output value is true, you can increase the value provided in the optional max-items input attribute to be able to list more items (up to the maximum allowed list size of 10,000 items).

      Parameters:
      startDirectoryListingRequest -
      Returns:
      A Java Future containing the result of the StartDirectoryListing operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • startDirectoryListing

      default CompletableFuture<StartDirectoryListingResponse> startDirectoryListing(Consumer<StartDirectoryListingRequest.Builder> startDirectoryListingRequest)

      Retrieves a list of the contents of a directory from a remote SFTP server. You specify the connector ID, the output path, and the remote directory path. You can also specify the optional MaxItems value to control the maximum number of items that are listed from the remote directory. This API returns a list of all files and directories in the remote directory (up to the maximum value), but does not return files or folders in sub-directories. That is, it only returns a list of files and directories one-level deep.

      After you receive the listing file, you can provide the files that you want to transfer to the RetrieveFilePaths parameter of the StartFileTransfer API call.

      The naming convention for the output file is connector-ID-listing-ID.json. The output file contains the following information:

      • filePath: the complete path of a remote file, relative to the directory of the listing request for your SFTP connector on the remote server.

      • modifiedTimestamp: the last time the file was modified, in UTC time format. This field is optional. If the remote file attributes don't contain a timestamp, it is omitted from the file listing.

      • size: the size of the file, in bytes. This field is optional. If the remote file attributes don't contain a file size, it is omitted from the file listing.

      • path: the complete path of a remote directory, relative to the directory of the listing request for your SFTP connector on the remote server.

      • truncated: a flag indicating whether the list output contains all of the items contained in the remote directory or not. If your Truncated output value is true, you can increase the value provided in the optional max-items input attribute to be able to list more items (up to the maximum allowed list size of 10,000 items).


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

      Parameters:
      startDirectoryListingRequest - A Consumer that will call methods on StartDirectoryListingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartDirectoryListing operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • startFileTransfer

      default CompletableFuture<StartFileTransferResponse> startFileTransfer(StartFileTransferRequest startFileTransferRequest)

      Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.

      • For an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files you want to transfer.

      • For an SFTP connector, the file transfer can be either outbound or inbound. In both cases, you specify the ConnectorId. Depending on the direction of the transfer, you also specify the following items:

        • If you are transferring file from a partner's SFTP server to Amazon Web Services storage, you specify one or more RetrieveFilePaths to identify the files you want to transfer, and a LocalDirectoryPath to specify the destination folder.

        • If you are transferring file to a partner's SFTP server from Amazon Web Services storage, you specify one or more SendFilePaths to identify the files you want to transfer, and a RemoteDirectoryPath to specify the destination folder.

      Parameters:
      startFileTransferRequest -
      Returns:
      A Java Future containing the result of the StartFileTransfer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • startFileTransfer

      default CompletableFuture<StartFileTransferResponse> startFileTransfer(Consumer<StartFileTransferRequest.Builder> startFileTransferRequest)

      Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.

      • For an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files you want to transfer.

      • For an SFTP connector, the file transfer can be either outbound or inbound. In both cases, you specify the ConnectorId. Depending on the direction of the transfer, you also specify the following items:

        • If you are transferring file from a partner's SFTP server to Amazon Web Services storage, you specify one or more RetrieveFilePaths to identify the files you want to transfer, and a LocalDirectoryPath to specify the destination folder.

        • If you are transferring file to a partner's SFTP server from Amazon Web Services storage, you specify one or more SendFilePaths to identify the files you want to transfer, and a RemoteDirectoryPath to specify the destination folder.


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

      Parameters:
      startFileTransferRequest - A Consumer that will call methods on StartFileTransferRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartFileTransfer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • startRemoteDelete

      default CompletableFuture<StartRemoteDeleteResponse> startRemoteDelete(StartRemoteDeleteRequest startRemoteDeleteRequest)

      Deletes a file or directory on the remote SFTP server.

      Parameters:
      startRemoteDeleteRequest -
      Returns:
      A Java Future containing the result of the StartRemoteDelete operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • startRemoteDelete

      default CompletableFuture<StartRemoteDeleteResponse> startRemoteDelete(Consumer<StartRemoteDeleteRequest.Builder> startRemoteDeleteRequest)

      Deletes a file or directory on the remote SFTP server.


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

      Parameters:
      startRemoteDeleteRequest - A Consumer that will call methods on StartRemoteDeleteRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartRemoteDelete operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • startRemoteMove

      default CompletableFuture<StartRemoteMoveResponse> startRemoteMove(StartRemoteMoveRequest startRemoteMoveRequest)

      Moves or renames a file or directory on the remote SFTP server.

      Parameters:
      startRemoteMoveRequest -
      Returns:
      A Java Future containing the result of the StartRemoteMove operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • startRemoteMove

      default CompletableFuture<StartRemoteMoveResponse> startRemoteMove(Consumer<StartRemoteMoveRequest.Builder> startRemoteMoveRequest)

      Moves or renames a file or directory on the remote SFTP server.


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

      Parameters:
      startRemoteMoveRequest - A Consumer that will call methods on StartRemoteMoveRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartRemoteMove operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • startServer

      default CompletableFuture<StartServerResponse> startServer(StartServerRequest startServerRequest)

      Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.

      The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.

      No response is returned from this call.

      Parameters:
      startServerRequest -
      Returns:
      A Java Future containing the result of the StartServer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • startServer

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

      Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.

      The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.

      No response is returned from this call.


      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • stopServer

      default CompletableFuture<StopServerResponse> stopServer(StopServerRequest stopServerRequest)

      Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server.

      Stopping the server does not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.

      The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.

      No response is returned from this call.

      Parameters:
      stopServerRequest -
      Returns:
      A Java Future containing the result of the StopServer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • stopServer

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

      Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server.

      Stopping the server does not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.

      The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.

      No response is returned from this call.


      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • testConnection

      default CompletableFuture<TestConnectionResponse> testConnection(TestConnectionRequest testConnectionRequest)

      Tests whether your SFTP connector is set up successfully. We highly recommend that you call this operation to test your ability to transfer files between local Amazon Web Services storage and a trading partner's SFTP server.

      Parameters:
      testConnectionRequest -
      Returns:
      A Java Future containing the result of the TestConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • testConnection

      default CompletableFuture<TestConnectionResponse> testConnection(Consumer<TestConnectionRequest.Builder> testConnectionRequest)

      Tests whether your SFTP connector is set up successfully. We highly recommend that you call this operation to test your ability to transfer files between local Amazon Web Services storage and a trading partner's SFTP server.


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

      Parameters:
      testConnectionRequest - A Consumer that will call methods on TestConnectionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TestConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • testIdentityProvider

      default CompletableFuture<TestIdentityProviderResponse> testIdentityProvider(TestIdentityProviderRequest testIdentityProviderRequest)

      If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service.

      The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional.

      Note the following:

      • You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED.

      • TestIdentityProvider does not work with keys: it only accepts passwords.

      • TestIdentityProvider can test the password operation for a custom Identity Provider that handles keys and passwords.

      • If you provide any incorrect values for any parameters, the Response field is empty.

      • If you provide a server ID for a server that uses service-managed users, you get an error:

        An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth

      • If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer server, you receive the following error:

        An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server .

        It is possible your sever is in a different region. You can specify a region by adding the following: --region region-code, such as --region us-east-2 to specify a server in US East (Ohio).

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • testIdentityProvider

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

      If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service.

      The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional.

      Note the following:

      • You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED.

      • TestIdentityProvider does not work with keys: it only accepts passwords.

      • TestIdentityProvider can test the password operation for a custom Identity Provider that handles keys and passwords.

      • If you provide any incorrect values for any parameters, the Response field is empty.

      • If you provide a server ID for a server that uses service-managed users, you get an error:

        An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth

      • If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer server, you receive the following error:

        An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server .

        It is possible your sever is in a different region. You can specify a region by adding the following: --region region-code, such as --region us-east-2 to specify a server in US East (Ohio).


      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • updateAccess

      default CompletableFuture<UpdateAccessResponse> updateAccess(UpdateAccessRequest updateAccessRequest)

      Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.

      Parameters:
      updateAccessRequest -
      Returns:
      A Java Future containing the result of the UpdateAccess operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • 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:

    • updateAccess

      default CompletableFuture<UpdateAccessResponse> updateAccess(Consumer<UpdateAccessRequest.Builder> updateAccessRequest)

      Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.


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

      Parameters:
      updateAccessRequest - A Consumer that will call methods on UpdateAccessRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAccess operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • 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:

    • updateAgreement

      default CompletableFuture<UpdateAgreementResponse> updateAgreement(UpdateAgreementRequest updateAgreementRequest)

      Updates some of the parameters for an existing agreement. Provide the AgreementId and the ServerId for the agreement that you want to update, along with the new values for the parameters to update.

      Specify either BaseDirectory or CustomDirectories, but not both. Specifying both causes the command to fail.

      If you update an agreement from using base directory to custom directories, the base directory is no longer used. Similarly, if you change from custom directories to a base directory, the custom directories are no longer used.

      Parameters:
      updateAgreementRequest -
      Returns:
      A Java Future containing the result of the UpdateAgreement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • 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:

    • updateAgreement

      default CompletableFuture<UpdateAgreementResponse> updateAgreement(Consumer<UpdateAgreementRequest.Builder> updateAgreementRequest)

      Updates some of the parameters for an existing agreement. Provide the AgreementId and the ServerId for the agreement that you want to update, along with the new values for the parameters to update.

      Specify either BaseDirectory or CustomDirectories, but not both. Specifying both causes the command to fail.

      If you update an agreement from using base directory to custom directories, the base directory is no longer used. Similarly, if you change from custom directories to a base directory, the custom directories are no longer used.


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

      Parameters:
      updateAgreementRequest - A Consumer that will call methods on UpdateAgreementRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAgreement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • 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:

    • updateCertificate

      default CompletableFuture<UpdateCertificateResponse> updateCertificate(UpdateCertificateRequest updateCertificateRequest)

      Updates the active and inactive dates for a certificate.

      Parameters:
      updateCertificateRequest -
      Returns:
      A Java Future containing the result of the UpdateCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • updateCertificate

      default CompletableFuture<UpdateCertificateResponse> updateCertificate(Consumer<UpdateCertificateRequest.Builder> updateCertificateRequest)

      Updates the active and inactive dates for a certificate.


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

      Parameters:
      updateCertificateRequest - A Consumer that will call methods on UpdateCertificateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • updateConnector

      default CompletableFuture<UpdateConnectorResponse> updateConnector(UpdateConnectorRequest updateConnectorRequest)

      Updates some of the parameters for an existing connector. Provide the ConnectorId for the connector that you want to update, along with the new values for the parameters to update.

      Parameters:
      updateConnectorRequest -
      Returns:
      A Java Future containing the result of the UpdateConnector operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • 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:

    • updateConnector

      default CompletableFuture<UpdateConnectorResponse> updateConnector(Consumer<UpdateConnectorRequest.Builder> updateConnectorRequest)

      Updates some of the parameters for an existing connector. Provide the ConnectorId for the connector that you want to update, along with the new values for the parameters to update.


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

      Parameters:
      updateConnectorRequest - A Consumer that will call methods on UpdateConnectorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateConnector operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • 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:

    • updateHostKey

      default CompletableFuture<UpdateHostKeyResponse> updateHostKey(UpdateHostKeyRequest updateHostKeyRequest)

      Updates the description for the host key that's specified by the ServerId and HostKeyId parameters.

      Parameters:
      updateHostKeyRequest -
      Returns:
      A Java Future containing the result of the UpdateHostKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • updateHostKey

      default CompletableFuture<UpdateHostKeyResponse> updateHostKey(Consumer<UpdateHostKeyRequest.Builder> updateHostKeyRequest)

      Updates the description for the host key that's specified by the ServerId and HostKeyId parameters.


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

      Parameters:
      updateHostKeyRequest - A Consumer that will call methods on UpdateHostKeyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateHostKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • updateProfile

      default CompletableFuture<UpdateProfileResponse> updateProfile(UpdateProfileRequest updateProfileRequest)

      Updates some of the parameters for an existing profile. Provide the ProfileId for the profile that you want to update, along with the new values for the parameters to update.

      Parameters:
      updateProfileRequest -
      Returns:
      A Java Future containing the result of the UpdateProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • updateProfile

      default CompletableFuture<UpdateProfileResponse> updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest)

      Updates some of the parameters for an existing profile. Provide the ProfileId for the profile that you want to update, along with the new values for the parameters to update.


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

      Parameters:
      updateProfileRequest - A Consumer that will call methods on UpdateProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • updateServer

      default CompletableFuture<UpdateServerResponse> updateServer(UpdateServerRequest updateServerRequest)

      Updates the file transfer protocol-enabled server's properties after that server has been created.

      The UpdateServer call returns the ServerId of the server you updated.

      Parameters:
      updateServerRequest -
      Returns:
      A Java Future containing the result of the UpdateServer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException This exception is thrown when the UpdateServer is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • updateServer

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

      Updates the file transfer protocol-enabled server's properties after that server has been created.

      The UpdateServer call returns the ServerId of the server you updated.


      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException This exception is thrown when the UpdateServer is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • 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.

      In the console, you can select Restricted when you create or update a user. This ensures that the user can't access anything outside of their home directory. The programmatic way to configure this behavior is to update the user. Set their HomeDirectoryType to LOGICAL, and specify HomeDirectoryMappings with Entry as root (/) and Target as their home directory.

      For example, if the user's home directory is /test/admin-user, the following command updates the user so that their configuration in the console shows the Restricted flag as selected.

      aws transfer update-user --server-id <server-id> --user-name admin-user --home-directory-type LOGICAL --home-directory-mappings "[{\"Entry\":\"/\", \"Target\":\"/test/admin-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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • 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.

      In the console, you can select Restricted when you create or update a user. This ensures that the user can't access anything outside of their home directory. The programmatic way to configure this behavior is to update the user. Set their HomeDirectoryType to LOGICAL, and specify HomeDirectoryMappings with Entry as root (/) and Target as their home directory.

      For example, if the user's home directory is /test/admin-user, the following command updates the user so that their configuration in the console shows the Restricted flag as selected.

      aws transfer update-user --server-id <server-id> --user-name admin-user --home-directory-type LOGICAL --home-directory-mappings "[{\"Entry\":\"/\", \"Target\":\"/test/admin-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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
      • 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:

    • updateWebApp

      default CompletableFuture<UpdateWebAppResponse> updateWebApp(UpdateWebAppRequest updateWebAppRequest)

      Assigns new properties to a web app. You can modify the access point, identity provider details, and the web app units.

      Parameters:
      updateWebAppRequest -
      Returns:
      A Java Future containing the result of the UpdateWebApp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException This exception is thrown when the UpdateServer is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • updateWebApp

      default CompletableFuture<UpdateWebAppResponse> updateWebApp(Consumer<UpdateWebAppRequest.Builder> updateWebAppRequest)

      Assigns new properties to a web app. You can modify the access point, identity provider details, and the web app units.


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

      Parameters:
      updateWebAppRequest - A Consumer that will call methods on UpdateWebAppRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateWebApp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException This exception is thrown when the UpdateServer is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • updateWebAppCustomization

      default CompletableFuture<UpdateWebAppCustomizationResponse> updateWebAppCustomization(UpdateWebAppCustomizationRequest updateWebAppCustomizationRequest)

      Assigns new customization properties to a web app. You can modify the icon file, logo file, and title.

      Parameters:
      updateWebAppCustomizationRequest -
      Returns:
      A Java Future containing the result of the UpdateWebAppCustomization operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException This exception is thrown when the UpdateServer is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • updateWebAppCustomization

      default CompletableFuture<UpdateWebAppCustomizationResponse> updateWebAppCustomization(Consumer<UpdateWebAppCustomizationRequest.Builder> updateWebAppCustomizationRequest)

      Assigns new customization properties to a web app. You can modify the icon file, logo file, and title.


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

      Parameters:
      updateWebAppCustomizationRequest - A Consumer that will call methods on UpdateWebAppCustomizationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateWebAppCustomization operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException This exception is thrown when the UpdateServer is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.
      • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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:

    • waiter

      default TransferAsyncWaiter waiter()
      Create an instance of TransferAsyncWaiter using this client.

      Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

      Returns:
      an instance of TransferAsyncWaiter

    • serviceClientConfiguration

      default TransferServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • 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.