/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.transfer; import javax.annotation.Generated; import com.amazonaws.services.transfer.model.*; /** * Interface for accessing AWS Transfer asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.transfer.AbstractAWSTransferAsync} instead. *

*

*

* 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 for processing, analytics, machine learning, and archiving. Getting * started with Transfer Family is easy since there is no infrastructure to buy and set up. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSTransferAsync extends AWSTransfer { /** *

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

* * @param createAccessRequest * @return A Java Future containing the result of the CreateAccess operation returned by the service. * @sample AWSTransferAsync.CreateAccess * @see AWS API * Documentation */ java.util.concurrent.Future createAccessAsync(CreateAccessRequest createAccessRequest); /** *

* Used by administrators to choose which groups in the directory should have access to upload and download files * over the enabled protocols using 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. *

* * @param createAccessRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateAccess operation returned by the service. * @sample AWSTransferAsyncHandler.CreateAccess * @see AWS API * Documentation */ java.util.concurrent.Future createAccessAsync(CreateAccessRequest createAccessRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param createAgreementRequest * @return A Java Future containing the result of the CreateAgreement operation returned by the service. * @sample AWSTransferAsync.CreateAgreement * @see AWS API * Documentation */ java.util.concurrent.Future createAgreementAsync(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. *

* * @param createAgreementRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateAgreement operation returned by the service. * @sample AWSTransferAsyncHandler.CreateAgreement * @see AWS API * Documentation */ java.util.concurrent.Future createAgreementAsync(CreateAgreementRequest createAgreementRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Creates the connector, which captures the parameters for an outbound connection for the AS2 or SFTP protocol. The * connector is required for sending files to an externally hosted AS2 or SFTP server. For more details about AS2 * connectors, see Create AS2 connectors. *

* *

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

* * * @param createConnectorRequest * @return A Java Future containing the result of the CreateConnector operation returned by the service. * @sample AWSTransferAsync.CreateConnector * @see AWS API * Documentation */ java.util.concurrent.Future createConnectorAsync(CreateConnectorRequest createConnectorRequest); /** *

* Creates the connector, which captures the parameters for an outbound connection for the AS2 or SFTP protocol. The * connector is required for sending files to an externally hosted AS2 or SFTP server. For more details about AS2 * connectors, see Create AS2 connectors. *

* *

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

* * * @param createConnectorRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateConnector operation returned by the service. * @sample AWSTransferAsyncHandler.CreateConnector * @see AWS API * Documentation */ java.util.concurrent.Future createConnectorAsync(CreateConnectorRequest createConnectorRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param createProfileRequest * @return A Java Future containing the result of the CreateProfile operation returned by the service. * @sample AWSTransferAsync.CreateProfile * @see AWS API * Documentation */ java.util.concurrent.Future createProfileAsync(CreateProfileRequest createProfileRequest); /** *

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

* * @param createProfileRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateProfile operation returned by the service. * @sample AWSTransferAsyncHandler.CreateProfile * @see AWS API * Documentation */ java.util.concurrent.Future createProfileAsync(CreateProfileRequest createProfileRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param createServerRequest * @return A Java Future containing the result of the CreateServer operation returned by the service. * @sample AWSTransferAsync.CreateServer * @see AWS API * Documentation */ java.util.concurrent.Future createServerAsync(CreateServerRequest createServerRequest); /** *

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

* * @param createServerRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateServer operation returned by the service. * @sample AWSTransferAsyncHandler.CreateServer * @see AWS API * Documentation */ java.util.concurrent.Future createServerAsync(CreateServerRequest createServerRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create * and associate users with servers that have the IdentityProviderType set to * SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set * the home directory, store the user's public key, and assign the user's 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. *

* * @param createUserRequest * @return A Java Future containing the result of the CreateUser operation returned by the service. * @sample AWSTransferAsync.CreateUser * @see AWS API * Documentation */ java.util.concurrent.Future createUserAsync(CreateUserRequest createUserRequest); /** *

* Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create * and associate users with servers that have the IdentityProviderType set to * SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set * the home directory, store the user's public key, and assign the user's 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. *

* * @param createUserRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateUser operation returned by the service. * @sample AWSTransferAsyncHandler.CreateUser * @see AWS API * Documentation */ java.util.concurrent.Future createUserAsync(CreateUserRequest createUserRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param createWorkflowRequest * @return A Java Future containing the result of the CreateWorkflow operation returned by the service. * @sample AWSTransferAsync.CreateWorkflow * @see AWS API * Documentation */ java.util.concurrent.Future createWorkflowAsync(CreateWorkflowRequest createWorkflowRequest); /** *

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

* * @param createWorkflowRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateWorkflow operation returned by the service. * @sample AWSTransferAsyncHandler.CreateWorkflow * @see AWS API * Documentation */ java.util.concurrent.Future createWorkflowAsync(CreateWorkflowRequest createWorkflowRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param deleteAccessRequest * @return A Java Future containing the result of the DeleteAccess operation returned by the service. * @sample AWSTransferAsync.DeleteAccess * @see AWS API * Documentation */ java.util.concurrent.Future deleteAccessAsync(DeleteAccessRequest deleteAccessRequest); /** *

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

* * @param deleteAccessRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteAccess operation returned by the service. * @sample AWSTransferAsyncHandler.DeleteAccess * @see AWS API * Documentation */ java.util.concurrent.Future deleteAccessAsync(DeleteAccessRequest deleteAccessRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param deleteAgreementRequest * @return A Java Future containing the result of the DeleteAgreement operation returned by the service. * @sample AWSTransferAsync.DeleteAgreement * @see AWS API * Documentation */ java.util.concurrent.Future deleteAgreementAsync(DeleteAgreementRequest deleteAgreementRequest); /** *

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

* * @param deleteAgreementRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteAgreement operation returned by the service. * @sample AWSTransferAsyncHandler.DeleteAgreement * @see AWS API * Documentation */ java.util.concurrent.Future deleteAgreementAsync(DeleteAgreementRequest deleteAgreementRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param deleteCertificateRequest * @return A Java Future containing the result of the DeleteCertificate operation returned by the service. * @sample AWSTransferAsync.DeleteCertificate * @see AWS API * Documentation */ java.util.concurrent.Future deleteCertificateAsync(DeleteCertificateRequest deleteCertificateRequest); /** *

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

* * @param deleteCertificateRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteCertificate operation returned by the service. * @sample AWSTransferAsyncHandler.DeleteCertificate * @see AWS API * Documentation */ java.util.concurrent.Future deleteCertificateAsync(DeleteCertificateRequest deleteCertificateRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param deleteConnectorRequest * @return A Java Future containing the result of the DeleteConnector operation returned by the service. * @sample AWSTransferAsync.DeleteConnector * @see AWS API * Documentation */ java.util.concurrent.Future deleteConnectorAsync(DeleteConnectorRequest deleteConnectorRequest); /** *

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

* * @param deleteConnectorRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteConnector operation returned by the service. * @sample AWSTransferAsyncHandler.DeleteConnector * @see AWS API * Documentation */ java.util.concurrent.Future deleteConnectorAsync(DeleteConnectorRequest deleteConnectorRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param deleteHostKeyRequest * @return A Java Future containing the result of the DeleteHostKey operation returned by the service. * @sample AWSTransferAsync.DeleteHostKey * @see AWS API * Documentation */ java.util.concurrent.Future deleteHostKeyAsync(DeleteHostKeyRequest deleteHostKeyRequest); /** *

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

* * @param deleteHostKeyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteHostKey operation returned by the service. * @sample AWSTransferAsyncHandler.DeleteHostKey * @see AWS API * Documentation */ java.util.concurrent.Future deleteHostKeyAsync(DeleteHostKeyRequest deleteHostKeyRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param deleteProfileRequest * @return A Java Future containing the result of the DeleteProfile operation returned by the service. * @sample AWSTransferAsync.DeleteProfile * @see AWS API * Documentation */ java.util.concurrent.Future deleteProfileAsync(DeleteProfileRequest deleteProfileRequest); /** *

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

* * @param deleteProfileRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteProfile operation returned by the service. * @sample AWSTransferAsyncHandler.DeleteProfile * @see AWS API * Documentation */ java.util.concurrent.Future deleteProfileAsync(DeleteProfileRequest deleteProfileRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

*

* No response returns from this operation. *

* * @param deleteServerRequest * @return A Java Future containing the result of the DeleteServer operation returned by the service. * @sample AWSTransferAsync.DeleteServer * @see AWS API * Documentation */ java.util.concurrent.Future deleteServerAsync(DeleteServerRequest deleteServerRequest); /** *

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

*

* No response returns from this operation. *

* * @param deleteServerRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteServer operation returned by the service. * @sample AWSTransferAsyncHandler.DeleteServer * @see AWS API * Documentation */ java.util.concurrent.Future deleteServerAsync(DeleteServerRequest deleteServerRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param deleteSshPublicKeyRequest * @return A Java Future containing the result of the DeleteSshPublicKey operation returned by the service. * @sample AWSTransferAsync.DeleteSshPublicKey * @see AWS * API Documentation */ java.util.concurrent.Future deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest); /** *

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

* * @param deleteSshPublicKeyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteSshPublicKey operation returned by the service. * @sample AWSTransferAsyncHandler.DeleteSshPublicKey * @see AWS * API Documentation */ java.util.concurrent.Future deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

*

* No response returns from this operation. *

* *

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

* * * @param deleteUserRequest * @return A Java Future containing the result of the DeleteUser operation returned by the service. * @sample AWSTransferAsync.DeleteUser * @see AWS API * Documentation */ java.util.concurrent.Future deleteUserAsync(DeleteUserRequest deleteUserRequest); /** *

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

*

* No response returns from this operation. *

* *

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

* * * @param deleteUserRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteUser operation returned by the service. * @sample AWSTransferAsyncHandler.DeleteUser * @see AWS API * Documentation */ java.util.concurrent.Future deleteUserAsync(DeleteUserRequest deleteUserRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Deletes the specified workflow. *

* * @param deleteWorkflowRequest * @return A Java Future containing the result of the DeleteWorkflow operation returned by the service. * @sample AWSTransferAsync.DeleteWorkflow * @see AWS API * Documentation */ java.util.concurrent.Future deleteWorkflowAsync(DeleteWorkflowRequest deleteWorkflowRequest); /** *

* Deletes the specified workflow. *

* * @param deleteWorkflowRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteWorkflow operation returned by the service. * @sample AWSTransferAsyncHandler.DeleteWorkflow * @see AWS API * Documentation */ java.util.concurrent.Future deleteWorkflowAsync(DeleteWorkflowRequest deleteWorkflowRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

*

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

* * @param describeAccessRequest * @return A Java Future containing the result of the DescribeAccess operation returned by the service. * @sample AWSTransferAsync.DescribeAccess * @see AWS API * Documentation */ java.util.concurrent.Future describeAccessAsync(DescribeAccessRequest describeAccessRequest); /** *

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

*

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

* * @param describeAccessRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeAccess operation returned by the service. * @sample AWSTransferAsyncHandler.DescribeAccess * @see AWS API * Documentation */ java.util.concurrent.Future describeAccessAsync(DescribeAccessRequest describeAccessRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Describes the agreement that's identified by the AgreementId. *

* * @param describeAgreementRequest * @return A Java Future containing the result of the DescribeAgreement operation returned by the service. * @sample AWSTransferAsync.DescribeAgreement * @see AWS API * Documentation */ java.util.concurrent.Future describeAgreementAsync(DescribeAgreementRequest describeAgreementRequest); /** *

* Describes the agreement that's identified by the AgreementId. *

* * @param describeAgreementRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeAgreement operation returned by the service. * @sample AWSTransferAsyncHandler.DescribeAgreement * @see AWS API * Documentation */ java.util.concurrent.Future describeAgreementAsync(DescribeAgreementRequest describeAgreementRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Describes the certificate that's identified by the CertificateId. *

* * @param describeCertificateRequest * @return A Java Future containing the result of the DescribeCertificate operation returned by the service. * @sample AWSTransferAsync.DescribeCertificate * @see AWS * API Documentation */ java.util.concurrent.Future describeCertificateAsync(DescribeCertificateRequest describeCertificateRequest); /** *

* Describes the certificate that's identified by the CertificateId. *

* * @param describeCertificateRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeCertificate operation returned by the service. * @sample AWSTransferAsyncHandler.DescribeCertificate * @see AWS * API Documentation */ java.util.concurrent.Future describeCertificateAsync(DescribeCertificateRequest describeCertificateRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Describes the connector that's identified by the ConnectorId. *

* * @param describeConnectorRequest * @return A Java Future containing the result of the DescribeConnector operation returned by the service. * @sample AWSTransferAsync.DescribeConnector * @see AWS API * Documentation */ java.util.concurrent.Future describeConnectorAsync(DescribeConnectorRequest describeConnectorRequest); /** *

* Describes the connector that's identified by the ConnectorId. *

* * @param describeConnectorRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeConnector operation returned by the service. * @sample AWSTransferAsyncHandler.DescribeConnector * @see AWS API * Documentation */ java.util.concurrent.Future describeConnectorAsync(DescribeConnectorRequest describeConnectorRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * * @param describeExecutionRequest * @return A Java Future containing the result of the DescribeExecution operation returned by the service. * @sample AWSTransferAsync.DescribeExecution * @see AWS API * Documentation */ java.util.concurrent.Future describeExecutionAsync(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. *

* * * @param describeExecutionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeExecution operation returned by the service. * @sample AWSTransferAsyncHandler.DescribeExecution * @see AWS API * Documentation */ java.util.concurrent.Future describeExecutionAsync(DescribeExecutionRequest describeExecutionRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param describeHostKeyRequest * @return A Java Future containing the result of the DescribeHostKey operation returned by the service. * @sample AWSTransferAsync.DescribeHostKey * @see AWS API * Documentation */ java.util.concurrent.Future describeHostKeyAsync(DescribeHostKeyRequest describeHostKeyRequest); /** *

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

* * @param describeHostKeyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeHostKey operation returned by the service. * @sample AWSTransferAsyncHandler.DescribeHostKey * @see AWS API * Documentation */ java.util.concurrent.Future describeHostKeyAsync(DescribeHostKeyRequest describeHostKeyRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param describeProfileRequest * @return A Java Future containing the result of the DescribeProfile operation returned by the service. * @sample AWSTransferAsync.DescribeProfile * @see AWS API * Documentation */ java.util.concurrent.Future describeProfileAsync(DescribeProfileRequest describeProfileRequest); /** *

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

* * @param describeProfileRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeProfile operation returned by the service. * @sample AWSTransferAsyncHandler.DescribeProfile * @see AWS API * Documentation */ java.util.concurrent.Future describeProfileAsync(DescribeProfileRequest describeProfileRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Describes the security policy that is attached to your file transfer protocol-enabled server. The response * contains a description of the security policy's properties. For more information about security policies, see Working with security * policies. *

* * @param describeSecurityPolicyRequest * @return A Java Future containing the result of the DescribeSecurityPolicy operation returned by the service. * @sample AWSTransferAsync.DescribeSecurityPolicy * @see AWS API Documentation */ java.util.concurrent.Future describeSecurityPolicyAsync(DescribeSecurityPolicyRequest describeSecurityPolicyRequest); /** *

* Describes the security policy that is attached to your file transfer protocol-enabled server. The response * contains a description of the security policy's properties. For more information about security policies, see Working with security * policies. *

* * @param describeSecurityPolicyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeSecurityPolicy operation returned by the service. * @sample AWSTransferAsyncHandler.DescribeSecurityPolicy * @see AWS API Documentation */ java.util.concurrent.Future describeSecurityPolicyAsync(DescribeSecurityPolicyRequest describeSecurityPolicyRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

*

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

* * @param describeServerRequest * @return A Java Future containing the result of the DescribeServer operation returned by the service. * @sample AWSTransferAsync.DescribeServer * @see AWS API * Documentation */ java.util.concurrent.Future describeServerAsync(DescribeServerRequest describeServerRequest); /** *

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

*

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

* * @param describeServerRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeServer operation returned by the service. * @sample AWSTransferAsyncHandler.DescribeServer * @see AWS API * Documentation */ java.util.concurrent.Future describeServerAsync(DescribeServerRequest describeServerRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

*

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

* * @param describeUserRequest * @return A Java Future containing the result of the DescribeUser operation returned by the service. * @sample AWSTransferAsync.DescribeUser * @see AWS API * Documentation */ java.util.concurrent.Future describeUserAsync(DescribeUserRequest describeUserRequest); /** *

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

*

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

* * @param describeUserRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeUser operation returned by the service. * @sample AWSTransferAsyncHandler.DescribeUser * @see AWS API * Documentation */ java.util.concurrent.Future describeUserAsync(DescribeUserRequest describeUserRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Describes the specified workflow. *

* * @param describeWorkflowRequest * @return A Java Future containing the result of the DescribeWorkflow operation returned by the service. * @sample AWSTransferAsync.DescribeWorkflow * @see AWS API * Documentation */ java.util.concurrent.Future describeWorkflowAsync(DescribeWorkflowRequest describeWorkflowRequest); /** *

* Describes the specified workflow. *

* * @param describeWorkflowRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeWorkflow operation returned by the service. * @sample AWSTransferAsyncHandler.DescribeWorkflow * @see AWS API * Documentation */ java.util.concurrent.Future describeWorkflowAsync(DescribeWorkflowRequest describeWorkflowRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param importCertificateRequest * @return A Java Future containing the result of the ImportCertificate operation returned by the service. * @sample AWSTransferAsync.ImportCertificate * @see AWS API * Documentation */ java.util.concurrent.Future importCertificateAsync(ImportCertificateRequest importCertificateRequest); /** *

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

* * @param importCertificateRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ImportCertificate operation returned by the service. * @sample AWSTransferAsyncHandler.ImportCertificate * @see AWS API * Documentation */ java.util.concurrent.Future importCertificateAsync(ImportCertificateRequest importCertificateRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param importHostKeyRequest * @return A Java Future containing the result of the ImportHostKey operation returned by the service. * @sample AWSTransferAsync.ImportHostKey * @see AWS API * Documentation */ java.util.concurrent.Future importHostKeyAsync(ImportHostKeyRequest importHostKeyRequest); /** *

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

* * @param importHostKeyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ImportHostKey operation returned by the service. * @sample AWSTransferAsyncHandler.ImportHostKey * @see AWS API * Documentation */ java.util.concurrent.Future importHostKeyAsync(ImportHostKeyRequest importHostKeyRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param importSshPublicKeyRequest * @return A Java Future containing the result of the ImportSshPublicKey operation returned by the service. * @sample AWSTransferAsync.ImportSshPublicKey * @see AWS * API Documentation */ java.util.concurrent.Future importSshPublicKeyAsync(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. *

* * @param importSshPublicKeyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ImportSshPublicKey operation returned by the service. * @sample AWSTransferAsyncHandler.ImportSshPublicKey * @see AWS * API Documentation */ java.util.concurrent.Future importSshPublicKeyAsync(ImportSshPublicKeyRequest importSshPublicKeyRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param listAccessesRequest * @return A Java Future containing the result of the ListAccesses operation returned by the service. * @sample AWSTransferAsync.ListAccesses * @see AWS API * Documentation */ java.util.concurrent.Future listAccessesAsync(ListAccessesRequest listAccessesRequest); /** *

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

* * @param listAccessesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListAccesses operation returned by the service. * @sample AWSTransferAsyncHandler.ListAccesses * @see AWS API * Documentation */ java.util.concurrent.Future listAccessesAsync(ListAccessesRequest listAccessesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param listAgreementsRequest * @return A Java Future containing the result of the ListAgreements operation returned by the service. * @sample AWSTransferAsync.ListAgreements * @see AWS API * Documentation */ java.util.concurrent.Future listAgreementsAsync(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. *

* * @param listAgreementsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListAgreements operation returned by the service. * @sample AWSTransferAsyncHandler.ListAgreements * @see AWS API * Documentation */ java.util.concurrent.Future listAgreementsAsync(ListAgreementsRequest listAgreementsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param listCertificatesRequest * @return A Java Future containing the result of the ListCertificates operation returned by the service. * @sample AWSTransferAsync.ListCertificates * @see AWS API * Documentation */ java.util.concurrent.Future listCertificatesAsync(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. *

* * @param listCertificatesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListCertificates operation returned by the service. * @sample AWSTransferAsyncHandler.ListCertificates * @see AWS API * Documentation */ java.util.concurrent.Future listCertificatesAsync(ListCertificatesRequest listCertificatesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Lists the connectors for the specified Region. *

* * @param listConnectorsRequest * @return A Java Future containing the result of the ListConnectors operation returned by the service. * @sample AWSTransferAsync.ListConnectors * @see AWS API * Documentation */ java.util.concurrent.Future listConnectorsAsync(ListConnectorsRequest listConnectorsRequest); /** *

* Lists the connectors for the specified Region. *

* * @param listConnectorsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListConnectors operation returned by the service. * @sample AWSTransferAsyncHandler.ListConnectors * @see AWS API * Documentation */ java.util.concurrent.Future listConnectorsAsync(ListConnectorsRequest listConnectorsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Lists all in-progress executions for the specified workflow. *

* *

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

* * * @param listExecutionsRequest * @return A Java Future containing the result of the ListExecutions operation returned by the service. * @sample AWSTransferAsync.ListExecutions * @see AWS API * Documentation */ java.util.concurrent.Future listExecutionsAsync(ListExecutionsRequest listExecutionsRequest); /** *

* Lists all in-progress executions for the specified workflow. *

* *

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

* * * @param listExecutionsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListExecutions operation returned by the service. * @sample AWSTransferAsyncHandler.ListExecutions * @see AWS API * Documentation */ java.util.concurrent.Future listExecutionsAsync(ListExecutionsRequest listExecutionsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param listHostKeysRequest * @return A Java Future containing the result of the ListHostKeys operation returned by the service. * @sample AWSTransferAsync.ListHostKeys * @see AWS API * Documentation */ java.util.concurrent.Future listHostKeysAsync(ListHostKeysRequest listHostKeysRequest); /** *

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

* * @param listHostKeysRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListHostKeys operation returned by the service. * @sample AWSTransferAsyncHandler.ListHostKeys * @see AWS API * Documentation */ java.util.concurrent.Future listHostKeysAsync(ListHostKeysRequest listHostKeysRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param listProfilesRequest * @return A Java Future containing the result of the ListProfiles operation returned by the service. * @sample AWSTransferAsync.ListProfiles * @see AWS API * Documentation */ java.util.concurrent.Future listProfilesAsync(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. *

* * @param listProfilesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListProfiles operation returned by the service. * @sample AWSTransferAsyncHandler.ListProfiles * @see AWS API * Documentation */ java.util.concurrent.Future listProfilesAsync(ListProfilesRequest listProfilesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Lists the security policies that are attached to your file transfer protocol-enabled servers. *

* * @param listSecurityPoliciesRequest * @return A Java Future containing the result of the ListSecurityPolicies operation returned by the service. * @sample AWSTransferAsync.ListSecurityPolicies * @see AWS * API Documentation */ java.util.concurrent.Future listSecurityPoliciesAsync(ListSecurityPoliciesRequest listSecurityPoliciesRequest); /** *

* Lists the security policies that are attached to your file transfer protocol-enabled servers. *

* * @param listSecurityPoliciesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListSecurityPolicies operation returned by the service. * @sample AWSTransferAsyncHandler.ListSecurityPolicies * @see AWS * API Documentation */ java.util.concurrent.Future listSecurityPoliciesAsync(ListSecurityPoliciesRequest listSecurityPoliciesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param listServersRequest * @return A Java Future containing the result of the ListServers operation returned by the service. * @sample AWSTransferAsync.ListServers * @see AWS API * Documentation */ java.util.concurrent.Future listServersAsync(ListServersRequest listServersRequest); /** *

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

* * @param listServersRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListServers operation returned by the service. * @sample AWSTransferAsyncHandler.ListServers * @see AWS API * Documentation */ java.util.concurrent.Future listServersAsync(ListServersRequest listServersRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param listTagsForResourceRequest * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSTransferAsync.ListTagsForResource * @see AWS * API Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest); /** *

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

* * @param listTagsForResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSTransferAsyncHandler.ListTagsForResource * @see AWS * API Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param listUsersRequest * @return A Java Future containing the result of the ListUsers operation returned by the service. * @sample AWSTransferAsync.ListUsers * @see AWS API * Documentation */ java.util.concurrent.Future listUsersAsync(ListUsersRequest listUsersRequest); /** *

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

* * @param listUsersRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListUsers operation returned by the service. * @sample AWSTransferAsyncHandler.ListUsers * @see AWS API * Documentation */ java.util.concurrent.Future listUsersAsync(ListUsersRequest listUsersRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param listWorkflowsRequest * @return A Java Future containing the result of the ListWorkflows operation returned by the service. * @sample AWSTransferAsync.ListWorkflows * @see AWS API * Documentation */ java.util.concurrent.Future listWorkflowsAsync(ListWorkflowsRequest listWorkflowsRequest); /** *

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

* * @param listWorkflowsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListWorkflows operation returned by the service. * @sample AWSTransferAsyncHandler.ListWorkflows * @see AWS API * Documentation */ java.util.concurrent.Future listWorkflowsAsync(ListWorkflowsRequest listWorkflowsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Sends a callback for asynchronous custom steps. *

*

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

* * @param sendWorkflowStepStateRequest * @return A Java Future containing the result of the SendWorkflowStepState operation returned by the service. * @sample AWSTransferAsync.SendWorkflowStepState * @see AWS * API Documentation */ java.util.concurrent.Future sendWorkflowStepStateAsync(SendWorkflowStepStateRequest sendWorkflowStepStateRequest); /** *

* Sends a callback for asynchronous custom steps. *

*

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

* * @param sendWorkflowStepStateRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the SendWorkflowStepState operation returned by the service. * @sample AWSTransferAsyncHandler.SendWorkflowStepState * @see AWS * API Documentation */ java.util.concurrent.Future sendWorkflowStepStateAsync(SendWorkflowStepStateRequest sendWorkflowStepStateRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 a Transfer Family server, you specify one or more * RetreiveFilePaths 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. *

      *
      • *
    *
    • *
* * @param startFileTransferRequest * @return A Java Future containing the result of the StartFileTransfer operation returned by the service. * @sample AWSTransferAsync.StartFileTransfer * @see AWS API * Documentation */ java.util.concurrent.Future startFileTransferAsync(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 a Transfer Family server, you specify one or more * RetreiveFilePaths 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. *

      *
      • *
    *
    • *
* * @param startFileTransferRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StartFileTransfer operation returned by the service. * @sample AWSTransferAsyncHandler.StartFileTransfer * @see AWS API * Documentation */ java.util.concurrent.Future startFileTransferAsync(StartFileTransferRequest startFileTransferRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

*

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

*

* No response is returned from this call. *

* * @param startServerRequest * @return A Java Future containing the result of the StartServer operation returned by the service. * @sample AWSTransferAsync.StartServer * @see AWS API * Documentation */ java.util.concurrent.Future startServerAsync(StartServerRequest startServerRequest); /** *

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

*

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

*

* No response is returned from this call. *

* * @param startServerRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StartServer operation returned by the service. * @sample AWSTransferAsyncHandler.StartServer * @see AWS API * Documentation */ java.util.concurrent.Future startServerAsync(StartServerRequest startServerRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* *

* Stopping the server 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. *

* * @param stopServerRequest * @return A Java Future containing the result of the StopServer operation returned by the service. * @sample AWSTransferAsync.StopServer * @see AWS API * Documentation */ java.util.concurrent.Future stopServerAsync(StopServerRequest stopServerRequest); /** *

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

* *

* Stopping the server 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. *

* * @param stopServerRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StopServer operation returned by the service. * @sample AWSTransferAsyncHandler.StopServer * @see AWS API * Documentation */ java.util.concurrent.Future stopServerAsync(StopServerRequest stopServerRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, * servers, roles, and other entities. *

*

* There is no response returned from this call. *

* * @param tagResourceRequest * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSTransferAsync.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest); /** *

* Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, * servers, roles, and other entities. *

*

* There is no response returned from this call. *

* * @param tagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSTransferAsyncHandler.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 a Transfer Family server and a trading partner's SFTP server. *

* * @param testConnectionRequest * @return A Java Future containing the result of the TestConnection operation returned by the service. * @sample AWSTransferAsync.TestConnection * @see AWS API * Documentation */ java.util.concurrent.Future testConnectionAsync(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 a Transfer Family server and a trading partner's SFTP server. *

* * @param testConnectionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the TestConnection operation returned by the service. * @sample AWSTransferAsyncHandler.TestConnection * @see AWS API * Documentation */ java.util.concurrent.Future testConnectionAsync(TestConnectionRequest testConnectionRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

*

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

*

* 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). *

    *
    • *
* * @param testIdentityProviderRequest * @return A Java Future containing the result of the TestIdentityProvider operation returned by the service. * @sample AWSTransferAsync.TestIdentityProvider * @see AWS * API Documentation */ java.util.concurrent.Future testIdentityProviderAsync(TestIdentityProviderRequest testIdentityProviderRequest); /** *

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

*

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

*

* 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). *

    *
    • *
* * @param testIdentityProviderRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the TestIdentityProvider operation returned by the service. * @sample AWSTransferAsyncHandler.TestIdentityProvider * @see AWS * API Documentation */ java.util.concurrent.Future testIdentityProviderAsync(TestIdentityProviderRequest testIdentityProviderRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, * servers, roles, and other entities. *

*

* No response is returned from this call. *

* * @param untagResourceRequest * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSTransferAsync.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest); /** *

* Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, * servers, roles, and other entities. *

*

* No response is returned from this call. *

* * @param untagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSTransferAsyncHandler.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param updateAccessRequest * @return A Java Future containing the result of the UpdateAccess operation returned by the service. * @sample AWSTransferAsync.UpdateAccess * @see AWS API * Documentation */ java.util.concurrent.Future updateAccessAsync(UpdateAccessRequest updateAccessRequest); /** *

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

* * @param updateAccessRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateAccess operation returned by the service. * @sample AWSTransferAsyncHandler.UpdateAccess * @see AWS API * Documentation */ java.util.concurrent.Future updateAccessAsync(UpdateAccessRequest updateAccessRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param updateAgreementRequest * @return A Java Future containing the result of the UpdateAgreement operation returned by the service. * @sample AWSTransferAsync.UpdateAgreement * @see AWS API * Documentation */ java.util.concurrent.Future updateAgreementAsync(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. *

* * @param updateAgreementRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateAgreement operation returned by the service. * @sample AWSTransferAsyncHandler.UpdateAgreement * @see AWS API * Documentation */ java.util.concurrent.Future updateAgreementAsync(UpdateAgreementRequest updateAgreementRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Updates the active and inactive dates for a certificate. *

* * @param updateCertificateRequest * @return A Java Future containing the result of the UpdateCertificate operation returned by the service. * @sample AWSTransferAsync.UpdateCertificate * @see AWS API * Documentation */ java.util.concurrent.Future updateCertificateAsync(UpdateCertificateRequest updateCertificateRequest); /** *

* Updates the active and inactive dates for a certificate. *

* * @param updateCertificateRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateCertificate operation returned by the service. * @sample AWSTransferAsyncHandler.UpdateCertificate * @see AWS API * Documentation */ java.util.concurrent.Future updateCertificateAsync(UpdateCertificateRequest updateCertificateRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param updateConnectorRequest * @return A Java Future containing the result of the UpdateConnector operation returned by the service. * @sample AWSTransferAsync.UpdateConnector * @see AWS API * Documentation */ java.util.concurrent.Future updateConnectorAsync(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. *

* * @param updateConnectorRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateConnector operation returned by the service. * @sample AWSTransferAsyncHandler.UpdateConnector * @see AWS API * Documentation */ java.util.concurrent.Future updateConnectorAsync(UpdateConnectorRequest updateConnectorRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param updateHostKeyRequest * @return A Java Future containing the result of the UpdateHostKey operation returned by the service. * @sample AWSTransferAsync.UpdateHostKey * @see AWS API * Documentation */ java.util.concurrent.Future updateHostKeyAsync(UpdateHostKeyRequest updateHostKeyRequest); /** *

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

* * @param updateHostKeyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateHostKey operation returned by the service. * @sample AWSTransferAsyncHandler.UpdateHostKey * @see AWS API * Documentation */ java.util.concurrent.Future updateHostKeyAsync(UpdateHostKeyRequest updateHostKeyRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param updateProfileRequest * @return A Java Future containing the result of the UpdateProfile operation returned by the service. * @sample AWSTransferAsync.UpdateProfile * @see AWS API * Documentation */ java.util.concurrent.Future updateProfileAsync(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. *

* * @param updateProfileRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateProfile operation returned by the service. * @sample AWSTransferAsyncHandler.UpdateProfile * @see AWS API * Documentation */ java.util.concurrent.Future updateProfileAsync(UpdateProfileRequest updateProfileRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

*

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

* * @param updateServerRequest * @return A Java Future containing the result of the UpdateServer operation returned by the service. * @sample AWSTransferAsync.UpdateServer * @see AWS API * Documentation */ java.util.concurrent.Future updateServerAsync(UpdateServerRequest updateServerRequest); /** *

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

*

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

* * @param updateServerRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateServer operation returned by the service. * @sample AWSTransferAsyncHandler.UpdateServer * @see AWS API * Documentation */ java.util.concurrent.Future updateServerAsync(UpdateServerRequest updateServerRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, * role, and policy for the UserName and ServerId you specify. *

*

* The response returns the ServerId and the UserName for the updated user. *

* * @param updateUserRequest * @return A Java Future containing the result of the UpdateUser operation returned by the service. * @sample AWSTransferAsync.UpdateUser * @see AWS API * Documentation */ java.util.concurrent.Future updateUserAsync(UpdateUserRequest updateUserRequest); /** *

* Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, * role, and policy for the UserName and ServerId you specify. *

*

* The response returns the ServerId and the UserName for the updated user. *

* * @param updateUserRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateUser operation returned by the service. * @sample AWSTransferAsyncHandler.UpdateUser * @see AWS API * Documentation */ java.util.concurrent.Future updateUserAsync(UpdateUserRequest updateUserRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); }