@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSTransferAsyncClient extends AWSTransferClient implements AWSTransferAsync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
static AWSTransferAsyncClientBuilder |
asyncBuilder() |
Future<CreateAccessResult> |
createAccessAsync(CreateAccessRequest request)
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.
|
Future<CreateAccessResult> |
createAccessAsync(CreateAccessRequest request,
AsyncHandler<CreateAccessRequest,CreateAccessResult> asyncHandler)
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.
|
Future<CreateAgreementResult> |
createAgreementAsync(CreateAgreementRequest request)
Creates an agreement.
|
Future<CreateAgreementResult> |
createAgreementAsync(CreateAgreementRequest request,
AsyncHandler<CreateAgreementRequest,CreateAgreementResult> asyncHandler)
Creates an agreement.
|
Future<CreateConnectorResult> |
createConnectorAsync(CreateConnectorRequest request)
Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.
|
Future<CreateConnectorResult> |
createConnectorAsync(CreateConnectorRequest request,
AsyncHandler<CreateConnectorRequest,CreateConnectorResult> asyncHandler)
Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.
|
Future<CreateProfileResult> |
createProfileAsync(CreateProfileRequest request)
Creates the local or partner profile to use for AS2 transfers.
|
Future<CreateProfileResult> |
createProfileAsync(CreateProfileRequest request,
AsyncHandler<CreateProfileRequest,CreateProfileResult> asyncHandler)
Creates the local or partner profile to use for AS2 transfers.
|
Future<CreateServerResult> |
createServerAsync(CreateServerRequest request)
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.
|
Future<CreateServerResult> |
createServerAsync(CreateServerRequest request,
AsyncHandler<CreateServerRequest,CreateServerResult> asyncHandler)
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.
|
Future<CreateUserResult> |
createUserAsync(CreateUserRequest request)
Creates a user and associates them with an existing file transfer protocol-enabled server.
|
Future<CreateUserResult> |
createUserAsync(CreateUserRequest request,
AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
Creates a user and associates them with an existing file transfer protocol-enabled server.
|
Future<CreateWorkflowResult> |
createWorkflowAsync(CreateWorkflowRequest request)
Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer
completes.
|
Future<CreateWorkflowResult> |
createWorkflowAsync(CreateWorkflowRequest request,
AsyncHandler<CreateWorkflowRequest,CreateWorkflowResult> asyncHandler)
Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer
completes.
|
Future<DeleteAccessResult> |
deleteAccessAsync(DeleteAccessRequest request)
Allows you to delete the access specified in the
ServerID and ExternalID parameters. |
Future<DeleteAccessResult> |
deleteAccessAsync(DeleteAccessRequest request,
AsyncHandler<DeleteAccessRequest,DeleteAccessResult> asyncHandler)
Allows you to delete the access specified in the
ServerID and ExternalID parameters. |
Future<DeleteAgreementResult> |
deleteAgreementAsync(DeleteAgreementRequest request)
Delete the agreement that's specified in the provided
AgreementId . |
Future<DeleteAgreementResult> |
deleteAgreementAsync(DeleteAgreementRequest request,
AsyncHandler<DeleteAgreementRequest,DeleteAgreementResult> asyncHandler)
Delete the agreement that's specified in the provided
AgreementId . |
Future<DeleteCertificateResult> |
deleteCertificateAsync(DeleteCertificateRequest request)
Deletes the certificate that's specified in the
CertificateId parameter. |
Future<DeleteCertificateResult> |
deleteCertificateAsync(DeleteCertificateRequest request,
AsyncHandler<DeleteCertificateRequest,DeleteCertificateResult> asyncHandler)
Deletes the certificate that's specified in the
CertificateId parameter. |
Future<DeleteConnectorResult> |
deleteConnectorAsync(DeleteConnectorRequest request)
Deletes the connector that's specified in the provided
ConnectorId . |
Future<DeleteConnectorResult> |
deleteConnectorAsync(DeleteConnectorRequest request,
AsyncHandler<DeleteConnectorRequest,DeleteConnectorResult> asyncHandler)
Deletes the connector that's specified in the provided
ConnectorId . |
Future<DeleteHostKeyResult> |
deleteHostKeyAsync(DeleteHostKeyRequest request)
Deletes the host key that's specified in the
HostKeyId parameter. |
Future<DeleteHostKeyResult> |
deleteHostKeyAsync(DeleteHostKeyRequest request,
AsyncHandler<DeleteHostKeyRequest,DeleteHostKeyResult> asyncHandler)
Deletes the host key that's specified in the
HostKeyId parameter. |
Future<DeleteProfileResult> |
deleteProfileAsync(DeleteProfileRequest request)
Deletes the profile that's specified in the
ProfileId parameter. |
Future<DeleteProfileResult> |
deleteProfileAsync(DeleteProfileRequest request,
AsyncHandler<DeleteProfileRequest,DeleteProfileResult> asyncHandler)
Deletes the profile that's specified in the
ProfileId parameter. |
Future<DeleteServerResult> |
deleteServerAsync(DeleteServerRequest request)
Deletes the file transfer protocol-enabled server that you specify.
|
Future<DeleteServerResult> |
deleteServerAsync(DeleteServerRequest request,
AsyncHandler<DeleteServerRequest,DeleteServerResult> asyncHandler)
Deletes the file transfer protocol-enabled server that you specify.
|
Future<DeleteSshPublicKeyResult> |
deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest request)
Deletes a user's Secure Shell (SSH) public key.
|
Future<DeleteSshPublicKeyResult> |
deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest request,
AsyncHandler<DeleteSshPublicKeyRequest,DeleteSshPublicKeyResult> asyncHandler)
Deletes a user's Secure Shell (SSH) public key.
|
Future<DeleteUserResult> |
deleteUserAsync(DeleteUserRequest request)
Deletes the user belonging to a file transfer protocol-enabled server you specify.
|
Future<DeleteUserResult> |
deleteUserAsync(DeleteUserRequest request,
AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
Deletes the user belonging to a file transfer protocol-enabled server you specify.
|
Future<DeleteWorkflowResult> |
deleteWorkflowAsync(DeleteWorkflowRequest request)
Deletes the specified workflow.
|
Future<DeleteWorkflowResult> |
deleteWorkflowAsync(DeleteWorkflowRequest request,
AsyncHandler<DeleteWorkflowRequest,DeleteWorkflowResult> asyncHandler)
Deletes the specified workflow.
|
Future<DescribeAccessResult> |
describeAccessAsync(DescribeAccessRequest request)
Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property and its ExternalId . |
Future<DescribeAccessResult> |
describeAccessAsync(DescribeAccessRequest request,
AsyncHandler<DescribeAccessRequest,DescribeAccessResult> asyncHandler)
Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property and its ExternalId . |
Future<DescribeAgreementResult> |
describeAgreementAsync(DescribeAgreementRequest request)
Describes the agreement that's identified by the
AgreementId . |
Future<DescribeAgreementResult> |
describeAgreementAsync(DescribeAgreementRequest request,
AsyncHandler<DescribeAgreementRequest,DescribeAgreementResult> asyncHandler)
Describes the agreement that's identified by the
AgreementId . |
Future<DescribeCertificateResult> |
describeCertificateAsync(DescribeCertificateRequest request)
Describes the certificate that's identified by the
CertificateId . |
Future<DescribeCertificateResult> |
describeCertificateAsync(DescribeCertificateRequest request,
AsyncHandler<DescribeCertificateRequest,DescribeCertificateResult> asyncHandler)
Describes the certificate that's identified by the
CertificateId . |
Future<DescribeConnectorResult> |
describeConnectorAsync(DescribeConnectorRequest request)
Describes the connector that's identified by the
ConnectorId. |
Future<DescribeConnectorResult> |
describeConnectorAsync(DescribeConnectorRequest request,
AsyncHandler<DescribeConnectorRequest,DescribeConnectorResult> asyncHandler)
Describes the connector that's identified by the
ConnectorId. |
Future<DescribeExecutionResult> |
describeExecutionAsync(DescribeExecutionRequest request)
You can use
DescribeExecution to check the details of the execution of the specified workflow. |
Future<DescribeExecutionResult> |
describeExecutionAsync(DescribeExecutionRequest request,
AsyncHandler<DescribeExecutionRequest,DescribeExecutionResult> asyncHandler)
You can use
DescribeExecution to check the details of the execution of the specified workflow. |
Future<DescribeHostKeyResult> |
describeHostKeyAsync(DescribeHostKeyRequest request)
Returns the details of the host key that's specified by the
HostKeyId and ServerId . |
Future<DescribeHostKeyResult> |
describeHostKeyAsync(DescribeHostKeyRequest request,
AsyncHandler<DescribeHostKeyRequest,DescribeHostKeyResult> asyncHandler)
Returns the details of the host key that's specified by the
HostKeyId and ServerId . |
Future<DescribeProfileResult> |
describeProfileAsync(DescribeProfileRequest request)
Returns the details of the profile that's specified by the
ProfileId . |
Future<DescribeProfileResult> |
describeProfileAsync(DescribeProfileRequest request,
AsyncHandler<DescribeProfileRequest,DescribeProfileResult> asyncHandler)
Returns the details of the profile that's specified by the
ProfileId . |
Future<DescribeSecurityPolicyResult> |
describeSecurityPolicyAsync(DescribeSecurityPolicyRequest request)
Describes the security policy that is attached to your server or SFTP connector.
|
Future<DescribeSecurityPolicyResult> |
describeSecurityPolicyAsync(DescribeSecurityPolicyRequest request,
AsyncHandler<DescribeSecurityPolicyRequest,DescribeSecurityPolicyResult> asyncHandler)
Describes the security policy that is attached to your server or SFTP connector.
|
Future<DescribeServerResult> |
describeServerAsync(DescribeServerRequest request)
Describes a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
Future<DescribeServerResult> |
describeServerAsync(DescribeServerRequest request,
AsyncHandler<DescribeServerRequest,DescribeServerResult> asyncHandler)
Describes a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
Future<DescribeUserResult> |
describeUserAsync(DescribeUserRequest request)
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property. |
Future<DescribeUserResult> |
describeUserAsync(DescribeUserRequest request,
AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property. |
Future<DescribeWorkflowResult> |
describeWorkflowAsync(DescribeWorkflowRequest request)
Describes the specified workflow.
|
Future<DescribeWorkflowResult> |
describeWorkflowAsync(DescribeWorkflowRequest request,
AsyncHandler<DescribeWorkflowRequest,DescribeWorkflowResult> asyncHandler)
Describes the specified workflow.
|
ExecutorService |
getExecutorService()
Returns the executor service used by this client to execute async requests.
|
Future<ImportCertificateResult> |
importCertificateAsync(ImportCertificateRequest request)
Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner
profiles.
|
Future<ImportCertificateResult> |
importCertificateAsync(ImportCertificateRequest request,
AsyncHandler<ImportCertificateRequest,ImportCertificateResult> asyncHandler)
Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner
profiles.
|
Future<ImportHostKeyResult> |
importHostKeyAsync(ImportHostKeyRequest request)
Adds a host key to the server that's specified by the
ServerId parameter. |
Future<ImportHostKeyResult> |
importHostKeyAsync(ImportHostKeyRequest request,
AsyncHandler<ImportHostKeyRequest,ImportHostKeyResult> asyncHandler)
Adds a host key to the server that's specified by the
ServerId parameter. |
Future<ImportSshPublicKeyResult> |
importSshPublicKeyAsync(ImportSshPublicKeyRequest request)
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 . |
Future<ImportSshPublicKeyResult> |
importSshPublicKeyAsync(ImportSshPublicKeyRequest request,
AsyncHandler<ImportSshPublicKeyRequest,ImportSshPublicKeyResult> 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 . |
Future<ListAccessesResult> |
listAccessesAsync(ListAccessesRequest request)
Lists the details for all the accesses you have on your server.
|
Future<ListAccessesResult> |
listAccessesAsync(ListAccessesRequest request,
AsyncHandler<ListAccessesRequest,ListAccessesResult> asyncHandler)
Lists the details for all the accesses you have on your server.
|
Future<ListAgreementsResult> |
listAgreementsAsync(ListAgreementsRequest request)
Returns a list of the agreements for the server that's identified by the
ServerId that you supply. |
Future<ListAgreementsResult> |
listAgreementsAsync(ListAgreementsRequest request,
AsyncHandler<ListAgreementsRequest,ListAgreementsResult> asyncHandler)
Returns a list of the agreements for the server that's identified by the
ServerId that you supply. |
Future<ListCertificatesResult> |
listCertificatesAsync(ListCertificatesRequest request)
Returns a list of the current certificates that have been imported into Transfer Family.
|
Future<ListCertificatesResult> |
listCertificatesAsync(ListCertificatesRequest request,
AsyncHandler<ListCertificatesRequest,ListCertificatesResult> asyncHandler)
Returns a list of the current certificates that have been imported into Transfer Family.
|
Future<ListConnectorsResult> |
listConnectorsAsync(ListConnectorsRequest request)
Lists the connectors for the specified Region.
|
Future<ListConnectorsResult> |
listConnectorsAsync(ListConnectorsRequest request,
AsyncHandler<ListConnectorsRequest,ListConnectorsResult> asyncHandler)
Lists the connectors for the specified Region.
|
Future<ListExecutionsResult> |
listExecutionsAsync(ListExecutionsRequest request)
Lists all in-progress executions for the specified workflow.
|
Future<ListExecutionsResult> |
listExecutionsAsync(ListExecutionsRequest request,
AsyncHandler<ListExecutionsRequest,ListExecutionsResult> asyncHandler)
Lists all in-progress executions for the specified workflow.
|
Future<ListHostKeysResult> |
listHostKeysAsync(ListHostKeysRequest request)
Returns a list of host keys for the server that's specified by the
ServerId parameter. |
Future<ListHostKeysResult> |
listHostKeysAsync(ListHostKeysRequest request,
AsyncHandler<ListHostKeysRequest,ListHostKeysResult> asyncHandler)
Returns a list of host keys for the server that's specified by the
ServerId parameter. |
Future<ListProfilesResult> |
listProfilesAsync(ListProfilesRequest request)
Returns a list of the profiles for your system.
|
Future<ListProfilesResult> |
listProfilesAsync(ListProfilesRequest request,
AsyncHandler<ListProfilesRequest,ListProfilesResult> asyncHandler)
Returns a list of the profiles for your system.
|
Future<ListSecurityPoliciesResult> |
listSecurityPoliciesAsync(ListSecurityPoliciesRequest request)
Lists the security policies that are attached to your servers and SFTP connectors.
|
Future<ListSecurityPoliciesResult> |
listSecurityPoliciesAsync(ListSecurityPoliciesRequest request,
AsyncHandler<ListSecurityPoliciesRequest,ListSecurityPoliciesResult> asyncHandler)
Lists the security policies that are attached to your servers and SFTP connectors.
|
Future<ListServersResult> |
listServersAsync(ListServersRequest request)
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
|
Future<ListServersResult> |
listServersAsync(ListServersRequest request,
AsyncHandler<ListServersRequest,ListServersResult> asyncHandler)
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest request)
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest request,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
|
Future<ListUsersResult> |
listUsersAsync(ListUsersRequest request)
Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
Future<ListUsersResult> |
listUsersAsync(ListUsersRequest request,
AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
Future<ListWorkflowsResult> |
listWorkflowsAsync(ListWorkflowsRequest request)
Lists all workflows associated with your Amazon Web Services account for your current region.
|
Future<ListWorkflowsResult> |
listWorkflowsAsync(ListWorkflowsRequest request,
AsyncHandler<ListWorkflowsRequest,ListWorkflowsResult> asyncHandler)
Lists all workflows associated with your Amazon Web Services account for your current region.
|
Future<SendWorkflowStepStateResult> |
sendWorkflowStepStateAsync(SendWorkflowStepStateRequest request)
Sends a callback for asynchronous custom steps.
|
Future<SendWorkflowStepStateResult> |
sendWorkflowStepStateAsync(SendWorkflowStepStateRequest request,
AsyncHandler<SendWorkflowStepStateRequest,SendWorkflowStepStateResult> asyncHandler)
Sends a callback for asynchronous custom steps.
|
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
Future<StartDirectoryListingResult> |
startDirectoryListingAsync(StartDirectoryListingRequest request)
Retrieves a list of the contents of a directory from a remote SFTP server.
|
Future<StartDirectoryListingResult> |
startDirectoryListingAsync(StartDirectoryListingRequest request,
AsyncHandler<StartDirectoryListingRequest,StartDirectoryListingResult> asyncHandler)
Retrieves a list of the contents of a directory from a remote SFTP server.
|
Future<StartFileTransferResult> |
startFileTransferAsync(StartFileTransferRequest request)
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
|
Future<StartFileTransferResult> |
startFileTransferAsync(StartFileTransferRequest request,
AsyncHandler<StartFileTransferRequest,StartFileTransferResult> asyncHandler)
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
|
Future<StartServerResult> |
startServerAsync(StartServerRequest request)
Changes the state of a file transfer protocol-enabled server from
OFFLINE to ONLINE . |
Future<StartServerResult> |
startServerAsync(StartServerRequest request,
AsyncHandler<StartServerRequest,StartServerResult> asyncHandler)
Changes the state of a file transfer protocol-enabled server from
OFFLINE to ONLINE . |
Future<StopServerResult> |
stopServerAsync(StopServerRequest request)
Changes the state of a file transfer protocol-enabled server from
ONLINE to OFFLINE . |
Future<StopServerResult> |
stopServerAsync(StopServerRequest request,
AsyncHandler<StopServerRequest,StopServerResult> asyncHandler)
Changes the state of a file transfer protocol-enabled server from
ONLINE to OFFLINE . |
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest request)
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest request,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
|
Future<TestConnectionResult> |
testConnectionAsync(TestConnectionRequest request)
Tests whether your SFTP connector is set up successfully.
|
Future<TestConnectionResult> |
testConnectionAsync(TestConnectionRequest request,
AsyncHandler<TestConnectionRequest,TestConnectionResult> asyncHandler)
Tests whether your SFTP connector is set up successfully.
|
Future<TestIdentityProviderResult> |
testIdentityProviderAsync(TestIdentityProviderRequest request)
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. |
Future<TestIdentityProviderResult> |
testIdentityProviderAsync(TestIdentityProviderRequest request,
AsyncHandler<TestIdentityProviderRequest,TestIdentityProviderResult> 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. |
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest request)
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest request,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
|
Future<UpdateAccessResult> |
updateAccessAsync(UpdateAccessRequest request)
Allows you to update parameters for the access specified in the
ServerID and ExternalID
parameters. |
Future<UpdateAccessResult> |
updateAccessAsync(UpdateAccessRequest request,
AsyncHandler<UpdateAccessRequest,UpdateAccessResult> asyncHandler)
Allows you to update parameters for the access specified in the
ServerID and ExternalID
parameters. |
Future<UpdateAgreementResult> |
updateAgreementAsync(UpdateAgreementRequest request)
Updates some of the parameters for an existing agreement.
|
Future<UpdateAgreementResult> |
updateAgreementAsync(UpdateAgreementRequest request,
AsyncHandler<UpdateAgreementRequest,UpdateAgreementResult> asyncHandler)
Updates some of the parameters for an existing agreement.
|
Future<UpdateCertificateResult> |
updateCertificateAsync(UpdateCertificateRequest request)
Updates the active and inactive dates for a certificate.
|
Future<UpdateCertificateResult> |
updateCertificateAsync(UpdateCertificateRequest request,
AsyncHandler<UpdateCertificateRequest,UpdateCertificateResult> asyncHandler)
Updates the active and inactive dates for a certificate.
|
Future<UpdateConnectorResult> |
updateConnectorAsync(UpdateConnectorRequest request)
Updates some of the parameters for an existing connector.
|
Future<UpdateConnectorResult> |
updateConnectorAsync(UpdateConnectorRequest request,
AsyncHandler<UpdateConnectorRequest,UpdateConnectorResult> asyncHandler)
Updates some of the parameters for an existing connector.
|
Future<UpdateHostKeyResult> |
updateHostKeyAsync(UpdateHostKeyRequest request)
Updates the description for the host key that's specified by the
ServerId and HostKeyId
parameters. |
Future<UpdateHostKeyResult> |
updateHostKeyAsync(UpdateHostKeyRequest request,
AsyncHandler<UpdateHostKeyRequest,UpdateHostKeyResult> asyncHandler)
Updates the description for the host key that's specified by the
ServerId and HostKeyId
parameters. |
Future<UpdateProfileResult> |
updateProfileAsync(UpdateProfileRequest request)
Updates some of the parameters for an existing profile.
|
Future<UpdateProfileResult> |
updateProfileAsync(UpdateProfileRequest request,
AsyncHandler<UpdateProfileRequest,UpdateProfileResult> asyncHandler)
Updates some of the parameters for an existing profile.
|
Future<UpdateServerResult> |
updateServerAsync(UpdateServerRequest request)
Updates the file transfer protocol-enabled server's properties after that server has been created.
|
Future<UpdateServerResult> |
updateServerAsync(UpdateServerRequest request,
AsyncHandler<UpdateServerRequest,UpdateServerResult> asyncHandler)
Updates the file transfer protocol-enabled server's properties after that server has been created.
|
Future<UpdateUserResult> |
updateUserAsync(UpdateUserRequest request)
Assigns new properties to a user.
|
Future<UpdateUserResult> |
updateUserAsync(UpdateUserRequest request,
AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
Assigns new properties to a user.
|
builder, createAccess, createAgreement, createConnector, createProfile, createServer, createUser, createWorkflow, deleteAccess, deleteAgreement, deleteCertificate, deleteConnector, deleteHostKey, deleteProfile, deleteServer, deleteSshPublicKey, deleteUser, deleteWorkflow, describeAccess, describeAgreement, describeCertificate, describeConnector, describeExecution, describeHostKey, describeProfile, describeSecurityPolicy, describeServer, describeUser, describeWorkflow, getCachedResponseMetadata, importCertificate, importHostKey, importSshPublicKey, listAccesses, listAgreements, listCertificates, listConnectors, listExecutions, listHostKeys, listProfiles, listSecurityPolicies, listServers, listTagsForResource, listUsers, listWorkflows, sendWorkflowStepState, startDirectoryListing, startFileTransfer, startServer, stopServer, tagResource, testConnection, testIdentityProvider, untagResource, updateAccess, updateAgreement, updateCertificate, updateConnector, updateHostKey, updateProfile, updateServer, updateUser, waiters
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createAccess, createAgreement, createConnector, createProfile, createServer, createUser, createWorkflow, deleteAccess, deleteAgreement, deleteCertificate, deleteConnector, deleteHostKey, deleteProfile, deleteServer, deleteSshPublicKey, deleteUser, deleteWorkflow, describeAccess, describeAgreement, describeCertificate, describeConnector, describeExecution, describeHostKey, describeProfile, describeSecurityPolicy, describeServer, describeUser, describeWorkflow, getCachedResponseMetadata, importCertificate, importHostKey, importSshPublicKey, listAccesses, listAgreements, listCertificates, listConnectors, listExecutions, listHostKeys, listProfiles, listSecurityPolicies, listServers, listTagsForResource, listUsers, listWorkflows, sendWorkflowStepState, startDirectoryListing, startFileTransfer, startServer, stopServer, tagResource, testConnection, testIdentityProvider, untagResource, updateAccess, updateAgreement, updateCertificate, updateConnector, updateHostKey, updateProfile, updateServer, updateUser, waiters
public static AWSTransferAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateAccessResult> createAccessAsync(CreateAccessRequest request)
AWSTransferAsync
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.
createAccessAsync
in interface AWSTransferAsync
public Future<CreateAccessResult> createAccessAsync(CreateAccessRequest request, AsyncHandler<CreateAccessRequest,CreateAccessResult> asyncHandler)
AWSTransferAsync
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.
createAccessAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateAgreementResult> createAgreementAsync(CreateAgreementRequest request)
AWSTransferAsync
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
.
createAgreementAsync
in interface AWSTransferAsync
public Future<CreateAgreementResult> createAgreementAsync(CreateAgreementRequest request, AsyncHandler<CreateAgreementRequest,CreateAgreementResult> asyncHandler)
AWSTransferAsync
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
.
createAgreementAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateConnectorResult> createConnectorAsync(CreateConnectorRequest request)
AWSTransferAsync
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
).
createConnectorAsync
in interface AWSTransferAsync
public Future<CreateConnectorResult> createConnectorAsync(CreateConnectorRequest request, AsyncHandler<CreateConnectorRequest,CreateConnectorResult> asyncHandler)
AWSTransferAsync
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
).
createConnectorAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateProfileResult> createProfileAsync(CreateProfileRequest request)
AWSTransferAsync
Creates the local or partner profile to use for AS2 transfers.
createProfileAsync
in interface AWSTransferAsync
public Future<CreateProfileResult> createProfileAsync(CreateProfileRequest request, AsyncHandler<CreateProfileRequest,CreateProfileResult> asyncHandler)
AWSTransferAsync
Creates the local or partner profile to use for AS2 transfers.
createProfileAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateServerResult> createServerAsync(CreateServerRequest request)
AWSTransferAsync
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.
createServerAsync
in interface AWSTransferAsync
public Future<CreateServerResult> createServerAsync(CreateServerRequest request, AsyncHandler<CreateServerRequest,CreateServerResult> asyncHandler)
AWSTransferAsync
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.
createServerAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateUserResult> createUserAsync(CreateUserRequest request)
AWSTransferAsync
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.
createUserAsync
in interface AWSTransferAsync
public Future<CreateUserResult> createUserAsync(CreateUserRequest request, AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
AWSTransferAsync
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.
createUserAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateWorkflowResult> createWorkflowAsync(CreateWorkflowRequest request)
AWSTransferAsync
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.
createWorkflowAsync
in interface AWSTransferAsync
public Future<CreateWorkflowResult> createWorkflowAsync(CreateWorkflowRequest request, AsyncHandler<CreateWorkflowRequest,CreateWorkflowResult> asyncHandler)
AWSTransferAsync
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.
createWorkflowAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteAccessResult> deleteAccessAsync(DeleteAccessRequest request)
AWSTransferAsync
Allows you to delete the access specified in the ServerID
and ExternalID
parameters.
deleteAccessAsync
in interface AWSTransferAsync
public Future<DeleteAccessResult> deleteAccessAsync(DeleteAccessRequest request, AsyncHandler<DeleteAccessRequest,DeleteAccessResult> asyncHandler)
AWSTransferAsync
Allows you to delete the access specified in the ServerID
and ExternalID
parameters.
deleteAccessAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteAgreementResult> deleteAgreementAsync(DeleteAgreementRequest request)
AWSTransferAsync
Delete the agreement that's specified in the provided AgreementId
.
deleteAgreementAsync
in interface AWSTransferAsync
public Future<DeleteAgreementResult> deleteAgreementAsync(DeleteAgreementRequest request, AsyncHandler<DeleteAgreementRequest,DeleteAgreementResult> asyncHandler)
AWSTransferAsync
Delete the agreement that's specified in the provided AgreementId
.
deleteAgreementAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteCertificateResult> deleteCertificateAsync(DeleteCertificateRequest request)
AWSTransferAsync
Deletes the certificate that's specified in the CertificateId
parameter.
deleteCertificateAsync
in interface AWSTransferAsync
public Future<DeleteCertificateResult> deleteCertificateAsync(DeleteCertificateRequest request, AsyncHandler<DeleteCertificateRequest,DeleteCertificateResult> asyncHandler)
AWSTransferAsync
Deletes the certificate that's specified in the CertificateId
parameter.
deleteCertificateAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteConnectorResult> deleteConnectorAsync(DeleteConnectorRequest request)
AWSTransferAsync
Deletes the connector that's specified in the provided ConnectorId
.
deleteConnectorAsync
in interface AWSTransferAsync
public Future<DeleteConnectorResult> deleteConnectorAsync(DeleteConnectorRequest request, AsyncHandler<DeleteConnectorRequest,DeleteConnectorResult> asyncHandler)
AWSTransferAsync
Deletes the connector that's specified in the provided ConnectorId
.
deleteConnectorAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteHostKeyResult> deleteHostKeyAsync(DeleteHostKeyRequest request)
AWSTransferAsync
Deletes the host key that's specified in the HostKeyId
parameter.
deleteHostKeyAsync
in interface AWSTransferAsync
public Future<DeleteHostKeyResult> deleteHostKeyAsync(DeleteHostKeyRequest request, AsyncHandler<DeleteHostKeyRequest,DeleteHostKeyResult> asyncHandler)
AWSTransferAsync
Deletes the host key that's specified in the HostKeyId
parameter.
deleteHostKeyAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteProfileResult> deleteProfileAsync(DeleteProfileRequest request)
AWSTransferAsync
Deletes the profile that's specified in the ProfileId
parameter.
deleteProfileAsync
in interface AWSTransferAsync
public Future<DeleteProfileResult> deleteProfileAsync(DeleteProfileRequest request, AsyncHandler<DeleteProfileRequest,DeleteProfileResult> asyncHandler)
AWSTransferAsync
Deletes the profile that's specified in the ProfileId
parameter.
deleteProfileAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteServerResult> deleteServerAsync(DeleteServerRequest request)
AWSTransferAsync
Deletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.
deleteServerAsync
in interface AWSTransferAsync
public Future<DeleteServerResult> deleteServerAsync(DeleteServerRequest request, AsyncHandler<DeleteServerRequest,DeleteServerResult> asyncHandler)
AWSTransferAsync
Deletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.
deleteServerAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteSshPublicKeyResult> deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest request)
AWSTransferAsync
Deletes a user's Secure Shell (SSH) public key.
deleteSshPublicKeyAsync
in interface AWSTransferAsync
public Future<DeleteSshPublicKeyResult> deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest request, AsyncHandler<DeleteSshPublicKeyRequest,DeleteSshPublicKeyResult> asyncHandler)
AWSTransferAsync
Deletes a user's Secure Shell (SSH) public key.
deleteSshPublicKeyAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request)
AWSTransferAsync
Deletes the user belonging to 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.
deleteUserAsync
in interface AWSTransferAsync
public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
AWSTransferAsync
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.
deleteUserAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteWorkflowResult> deleteWorkflowAsync(DeleteWorkflowRequest request)
AWSTransferAsync
Deletes the specified workflow.
deleteWorkflowAsync
in interface AWSTransferAsync
public Future<DeleteWorkflowResult> deleteWorkflowAsync(DeleteWorkflowRequest request, AsyncHandler<DeleteWorkflowRequest,DeleteWorkflowResult> asyncHandler)
AWSTransferAsync
Deletes the specified workflow.
deleteWorkflowAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAccessResult> describeAccessAsync(DescribeAccessRequest request)
AWSTransferAsync
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.
describeAccessAsync
in interface AWSTransferAsync
public Future<DescribeAccessResult> describeAccessAsync(DescribeAccessRequest request, AsyncHandler<DescribeAccessRequest,DescribeAccessResult> asyncHandler)
AWSTransferAsync
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.
describeAccessAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAgreementResult> describeAgreementAsync(DescribeAgreementRequest request)
AWSTransferAsync
Describes the agreement that's identified by the AgreementId
.
describeAgreementAsync
in interface AWSTransferAsync
public Future<DescribeAgreementResult> describeAgreementAsync(DescribeAgreementRequest request, AsyncHandler<DescribeAgreementRequest,DescribeAgreementResult> asyncHandler)
AWSTransferAsync
Describes the agreement that's identified by the AgreementId
.
describeAgreementAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeCertificateResult> describeCertificateAsync(DescribeCertificateRequest request)
AWSTransferAsync
Describes the certificate that's identified by the CertificateId
.
describeCertificateAsync
in interface AWSTransferAsync
public Future<DescribeCertificateResult> describeCertificateAsync(DescribeCertificateRequest request, AsyncHandler<DescribeCertificateRequest,DescribeCertificateResult> asyncHandler)
AWSTransferAsync
Describes the certificate that's identified by the CertificateId
.
describeCertificateAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeConnectorResult> describeConnectorAsync(DescribeConnectorRequest request)
AWSTransferAsync
Describes the connector that's identified by the ConnectorId.
describeConnectorAsync
in interface AWSTransferAsync
public Future<DescribeConnectorResult> describeConnectorAsync(DescribeConnectorRequest request, AsyncHandler<DescribeConnectorRequest,DescribeConnectorResult> asyncHandler)
AWSTransferAsync
Describes the connector that's identified by the ConnectorId.
describeConnectorAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeExecutionResult> describeExecutionAsync(DescribeExecutionRequest request)
AWSTransferAsync
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.
describeExecutionAsync
in interface AWSTransferAsync
public Future<DescribeExecutionResult> describeExecutionAsync(DescribeExecutionRequest request, AsyncHandler<DescribeExecutionRequest,DescribeExecutionResult> asyncHandler)
AWSTransferAsync
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.
describeExecutionAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeHostKeyResult> describeHostKeyAsync(DescribeHostKeyRequest request)
AWSTransferAsync
Returns the details of the host key that's specified by the HostKeyId
and ServerId
.
describeHostKeyAsync
in interface AWSTransferAsync
public Future<DescribeHostKeyResult> describeHostKeyAsync(DescribeHostKeyRequest request, AsyncHandler<DescribeHostKeyRequest,DescribeHostKeyResult> asyncHandler)
AWSTransferAsync
Returns the details of the host key that's specified by the HostKeyId
and ServerId
.
describeHostKeyAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeProfileResult> describeProfileAsync(DescribeProfileRequest request)
AWSTransferAsync
Returns the details of the profile that's specified by the ProfileId
.
describeProfileAsync
in interface AWSTransferAsync
public Future<DescribeProfileResult> describeProfileAsync(DescribeProfileRequest request, AsyncHandler<DescribeProfileRequest,DescribeProfileResult> asyncHandler)
AWSTransferAsync
Returns the details of the profile that's specified by the ProfileId
.
describeProfileAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeSecurityPolicyResult> describeSecurityPolicyAsync(DescribeSecurityPolicyRequest request)
AWSTransferAsync
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.
describeSecurityPolicyAsync
in interface AWSTransferAsync
public Future<DescribeSecurityPolicyResult> describeSecurityPolicyAsync(DescribeSecurityPolicyRequest request, AsyncHandler<DescribeSecurityPolicyRequest,DescribeSecurityPolicyResult> asyncHandler)
AWSTransferAsync
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.
describeSecurityPolicyAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeServerResult> describeServerAsync(DescribeServerRequest request)
AWSTransferAsync
Describes 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
.
describeServerAsync
in interface AWSTransferAsync
public Future<DescribeServerResult> describeServerAsync(DescribeServerRequest request, AsyncHandler<DescribeServerRequest,DescribeServerResult> asyncHandler)
AWSTransferAsync
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
.
describeServerAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request)
AWSTransferAsync
Describes the user assigned to 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.
describeUserAsync
in interface AWSTransferAsync
public Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request, AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)
AWSTransferAsync
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.
describeUserAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeWorkflowResult> describeWorkflowAsync(DescribeWorkflowRequest request)
AWSTransferAsync
Describes the specified workflow.
describeWorkflowAsync
in interface AWSTransferAsync
public Future<DescribeWorkflowResult> describeWorkflowAsync(DescribeWorkflowRequest request, AsyncHandler<DescribeWorkflowRequest,DescribeWorkflowResult> asyncHandler)
AWSTransferAsync
Describes the specified workflow.
describeWorkflowAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ImportCertificateResult> importCertificateAsync(ImportCertificateRequest request)
AWSTransferAsync
Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.
importCertificateAsync
in interface AWSTransferAsync
public Future<ImportCertificateResult> importCertificateAsync(ImportCertificateRequest request, AsyncHandler<ImportCertificateRequest,ImportCertificateResult> asyncHandler)
AWSTransferAsync
Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.
importCertificateAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ImportHostKeyResult> importHostKeyAsync(ImportHostKeyRequest request)
AWSTransferAsync
Adds a host key to the server that's specified by the ServerId
parameter.
importHostKeyAsync
in interface AWSTransferAsync
public Future<ImportHostKeyResult> importHostKeyAsync(ImportHostKeyRequest request, AsyncHandler<ImportHostKeyRequest,ImportHostKeyResult> asyncHandler)
AWSTransferAsync
Adds a host key to the server that's specified by the ServerId
parameter.
importHostKeyAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ImportSshPublicKeyResult> importSshPublicKeyAsync(ImportSshPublicKeyRequest request)
AWSTransferAsync
Adds a Secure Shell (SSH) public key to a 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
.
importSshPublicKeyAsync
in interface AWSTransferAsync
public Future<ImportSshPublicKeyResult> importSshPublicKeyAsync(ImportSshPublicKeyRequest request, AsyncHandler<ImportSshPublicKeyRequest,ImportSshPublicKeyResult> asyncHandler)
AWSTransferAsync
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
.
importSshPublicKeyAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListAccessesResult> listAccessesAsync(ListAccessesRequest request)
AWSTransferAsync
Lists the details for all the accesses you have on your server.
listAccessesAsync
in interface AWSTransferAsync
public Future<ListAccessesResult> listAccessesAsync(ListAccessesRequest request, AsyncHandler<ListAccessesRequest,ListAccessesResult> asyncHandler)
AWSTransferAsync
Lists the details for all the accesses you have on your server.
listAccessesAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListAgreementsResult> listAgreementsAsync(ListAgreementsRequest request)
AWSTransferAsync
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.
listAgreementsAsync
in interface AWSTransferAsync
public Future<ListAgreementsResult> listAgreementsAsync(ListAgreementsRequest request, AsyncHandler<ListAgreementsRequest,ListAgreementsResult> asyncHandler)
AWSTransferAsync
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.
listAgreementsAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListCertificatesResult> listCertificatesAsync(ListCertificatesRequest request)
AWSTransferAsync
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.
listCertificatesAsync
in interface AWSTransferAsync
public Future<ListCertificatesResult> listCertificatesAsync(ListCertificatesRequest request, AsyncHandler<ListCertificatesRequest,ListCertificatesResult> asyncHandler)
AWSTransferAsync
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.
listCertificatesAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListConnectorsResult> listConnectorsAsync(ListConnectorsRequest request)
AWSTransferAsync
Lists the connectors for the specified Region.
listConnectorsAsync
in interface AWSTransferAsync
public Future<ListConnectorsResult> listConnectorsAsync(ListConnectorsRequest request, AsyncHandler<ListConnectorsRequest,ListConnectorsResult> asyncHandler)
AWSTransferAsync
Lists the connectors for the specified Region.
listConnectorsAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest request)
AWSTransferAsync
Lists all in-progress executions for the specified workflow.
If the specified workflow ID cannot be found, ListExecutions
returns a ResourceNotFound
exception.
listExecutionsAsync
in interface AWSTransferAsync
public Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest request, AsyncHandler<ListExecutionsRequest,ListExecutionsResult> asyncHandler)
AWSTransferAsync
Lists all in-progress executions for the specified workflow.
If the specified workflow ID cannot be found, ListExecutions
returns a ResourceNotFound
exception.
listExecutionsAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListHostKeysResult> listHostKeysAsync(ListHostKeysRequest request)
AWSTransferAsync
Returns a list of host keys for the server that's specified by the ServerId
parameter.
listHostKeysAsync
in interface AWSTransferAsync
public Future<ListHostKeysResult> listHostKeysAsync(ListHostKeysRequest request, AsyncHandler<ListHostKeysRequest,ListHostKeysResult> asyncHandler)
AWSTransferAsync
Returns a list of host keys for the server that's specified by the ServerId
parameter.
listHostKeysAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListProfilesResult> listProfilesAsync(ListProfilesRequest request)
AWSTransferAsync
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.
listProfilesAsync
in interface AWSTransferAsync
public Future<ListProfilesResult> listProfilesAsync(ListProfilesRequest request, AsyncHandler<ListProfilesRequest,ListProfilesResult> asyncHandler)
AWSTransferAsync
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.
listProfilesAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListSecurityPoliciesResult> listSecurityPoliciesAsync(ListSecurityPoliciesRequest request)
AWSTransferAsync
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.
listSecurityPoliciesAsync
in interface AWSTransferAsync
public Future<ListSecurityPoliciesResult> listSecurityPoliciesAsync(ListSecurityPoliciesRequest request, AsyncHandler<ListSecurityPoliciesRequest,ListSecurityPoliciesResult> asyncHandler)
AWSTransferAsync
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.
listSecurityPoliciesAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListServersResult> listServersAsync(ListServersRequest request)
AWSTransferAsync
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
listServersAsync
in interface AWSTransferAsync
public Future<ListServersResult> listServersAsync(ListServersRequest request, AsyncHandler<ListServersRequest,ListServersResult> asyncHandler)
AWSTransferAsync
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
listServersAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSTransferAsync
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
listTagsForResourceAsync
in interface AWSTransferAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSTransferAsync
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
listTagsForResourceAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListUsersResult> listUsersAsync(ListUsersRequest request)
AWSTransferAsync
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
listUsersAsync
in interface AWSTransferAsync
public Future<ListUsersResult> listUsersAsync(ListUsersRequest request, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
AWSTransferAsync
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
listUsersAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListWorkflowsResult> listWorkflowsAsync(ListWorkflowsRequest request)
AWSTransferAsync
Lists all workflows associated with your Amazon Web Services account for your current region.
listWorkflowsAsync
in interface AWSTransferAsync
public Future<ListWorkflowsResult> listWorkflowsAsync(ListWorkflowsRequest request, AsyncHandler<ListWorkflowsRequest,ListWorkflowsResult> asyncHandler)
AWSTransferAsync
Lists all workflows associated with your Amazon Web Services account for your current region.
listWorkflowsAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SendWorkflowStepStateResult> sendWorkflowStepStateAsync(SendWorkflowStepStateRequest request)
AWSTransferAsync
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.
sendWorkflowStepStateAsync
in interface AWSTransferAsync
public Future<SendWorkflowStepStateResult> sendWorkflowStepStateAsync(SendWorkflowStepStateRequest request, AsyncHandler<SendWorkflowStepStateRequest,SendWorkflowStepStateResult> asyncHandler)
AWSTransferAsync
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.
sendWorkflowStepStateAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartDirectoryListingResult> startDirectoryListingAsync(StartDirectoryListingRequest request)
AWSTransferAsync
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).
startDirectoryListingAsync
in interface AWSTransferAsync
public Future<StartDirectoryListingResult> startDirectoryListingAsync(StartDirectoryListingRequest request, AsyncHandler<StartDirectoryListingRequest,StartDirectoryListingResult> asyncHandler)
AWSTransferAsync
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).
startDirectoryListingAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartFileTransferResult> startFileTransferAsync(StartFileTransferRequest request)
AWSTransferAsync
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.
startFileTransferAsync
in interface AWSTransferAsync
public Future<StartFileTransferResult> startFileTransferAsync(StartFileTransferRequest request, AsyncHandler<StartFileTransferRequest,StartFileTransferResult> asyncHandler)
AWSTransferAsync
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.
startFileTransferAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartServerResult> startServerAsync(StartServerRequest request)
AWSTransferAsync
Changes the state of a 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.
startServerAsync
in interface AWSTransferAsync
public Future<StartServerResult> startServerAsync(StartServerRequest request, AsyncHandler<StartServerRequest,StartServerResult> asyncHandler)
AWSTransferAsync
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.
startServerAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StopServerResult> stopServerAsync(StopServerRequest request)
AWSTransferAsync
Changes the state of 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.
stopServerAsync
in interface AWSTransferAsync
public Future<StopServerResult> stopServerAsync(StopServerRequest request, AsyncHandler<StopServerRequest,StopServerResult> asyncHandler)
AWSTransferAsync
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.
stopServerAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSTransferAsync
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
There is no response returned from this call.
tagResourceAsync
in interface AWSTransferAsync
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSTransferAsync
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
There is no response returned from this call.
tagResourceAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TestConnectionResult> testConnectionAsync(TestConnectionRequest request)
AWSTransferAsync
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.
testConnectionAsync
in interface AWSTransferAsync
public Future<TestConnectionResult> testConnectionAsync(TestConnectionRequest request, AsyncHandler<TestConnectionRequest,TestConnectionResult> asyncHandler)
AWSTransferAsync
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.
testConnectionAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TestIdentityProviderResult> testIdentityProviderAsync(TestIdentityProviderRequest request)
AWSTransferAsync
If the IdentityProviderType
of 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).
testIdentityProviderAsync
in interface AWSTransferAsync
public Future<TestIdentityProviderResult> testIdentityProviderAsync(TestIdentityProviderRequest request, AsyncHandler<TestIdentityProviderRequest,TestIdentityProviderResult> asyncHandler)
AWSTransferAsync
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).
testIdentityProviderAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSTransferAsync
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
No response is returned from this call.
untagResourceAsync
in interface AWSTransferAsync
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSTransferAsync
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
No response is returned from this call.
untagResourceAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateAccessResult> updateAccessAsync(UpdateAccessRequest request)
AWSTransferAsync
Allows you to update parameters for the access specified in the ServerID
and ExternalID
parameters.
updateAccessAsync
in interface AWSTransferAsync
public Future<UpdateAccessResult> updateAccessAsync(UpdateAccessRequest request, AsyncHandler<UpdateAccessRequest,UpdateAccessResult> asyncHandler)
AWSTransferAsync
Allows you to update parameters for the access specified in the ServerID
and ExternalID
parameters.
updateAccessAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateAgreementResult> updateAgreementAsync(UpdateAgreementRequest request)
AWSTransferAsync
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.
updateAgreementAsync
in interface AWSTransferAsync
public Future<UpdateAgreementResult> updateAgreementAsync(UpdateAgreementRequest request, AsyncHandler<UpdateAgreementRequest,UpdateAgreementResult> asyncHandler)
AWSTransferAsync
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.
updateAgreementAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateCertificateResult> updateCertificateAsync(UpdateCertificateRequest request)
AWSTransferAsync
Updates the active and inactive dates for a certificate.
updateCertificateAsync
in interface AWSTransferAsync
public Future<UpdateCertificateResult> updateCertificateAsync(UpdateCertificateRequest request, AsyncHandler<UpdateCertificateRequest,UpdateCertificateResult> asyncHandler)
AWSTransferAsync
Updates the active and inactive dates for a certificate.
updateCertificateAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateConnectorResult> updateConnectorAsync(UpdateConnectorRequest request)
AWSTransferAsync
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.
updateConnectorAsync
in interface AWSTransferAsync
public Future<UpdateConnectorResult> updateConnectorAsync(UpdateConnectorRequest request, AsyncHandler<UpdateConnectorRequest,UpdateConnectorResult> asyncHandler)
AWSTransferAsync
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.
updateConnectorAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateHostKeyResult> updateHostKeyAsync(UpdateHostKeyRequest request)
AWSTransferAsync
Updates the description for the host key that's specified by the ServerId
and HostKeyId
parameters.
updateHostKeyAsync
in interface AWSTransferAsync
public Future<UpdateHostKeyResult> updateHostKeyAsync(UpdateHostKeyRequest request, AsyncHandler<UpdateHostKeyRequest,UpdateHostKeyResult> asyncHandler)
AWSTransferAsync
Updates the description for the host key that's specified by the ServerId
and HostKeyId
parameters.
updateHostKeyAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateProfileResult> updateProfileAsync(UpdateProfileRequest request)
AWSTransferAsync
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.
updateProfileAsync
in interface AWSTransferAsync
public Future<UpdateProfileResult> updateProfileAsync(UpdateProfileRequest request, AsyncHandler<UpdateProfileRequest,UpdateProfileResult> asyncHandler)
AWSTransferAsync
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.
updateProfileAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateServerResult> updateServerAsync(UpdateServerRequest request)
AWSTransferAsync
Updates the file transfer protocol-enabled server's properties after that server has been created.
The UpdateServer
call returns the ServerId
of the server you updated.
updateServerAsync
in interface AWSTransferAsync
public Future<UpdateServerResult> updateServerAsync(UpdateServerRequest request, AsyncHandler<UpdateServerRequest,UpdateServerResult> asyncHandler)
AWSTransferAsync
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.
updateServerAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request)
AWSTransferAsync
Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory,
role, and policy for the UserName
and ServerId
you specify.
The response returns the ServerId
and the UserName
for the updated user.
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\"}]"
updateUserAsync
in interface AWSTransferAsync
public Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
AWSTransferAsync
Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory,
role, and policy for the UserName
and ServerId
you specify.
The response returns the ServerId
and the UserName
for the updated user.
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\"}]"
updateUserAsync
in interface AWSTransferAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AWSTransfer
shutdown
in class AWSTransferClient