@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSTransferAsync extends AbstractAWSTransfer implements AWSTransferAsync
AWSTransferAsync. Convenient method forms pass through to the corresponding
overload that takes a request object and an AsyncHandler, which throws an
UnsupportedOperationException.ENDPOINT_PREFIX| Modifier | Constructor and Description |
|---|---|
protected |
AbstractAWSTransferAsync() |
| Modifier and Type | Method and Description |
|---|---|
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 Amazon Web Services 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 Amazon Web Services Transfer Family.
|
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<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<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<DescribeSecurityPolicyResult> |
describeSecurityPolicyAsync(DescribeSecurityPolicyRequest request)
Describes the security policy that is attached to your file transfer protocol-enabled server.
|
Future<DescribeSecurityPolicyResult> |
describeSecurityPolicyAsync(DescribeSecurityPolicyRequest request,
AsyncHandler<DescribeSecurityPolicyRequest,DescribeSecurityPolicyResult> asyncHandler)
Describes the security policy that is attached to your file transfer protocol-enabled server.
|
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.
|
Future<ImportSshPublicKeyResult> |
importSshPublicKeyAsync(ImportSshPublicKeyRequest request)
Adds a Secure Shell (SSH) public key to a user account 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 user account 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<ListExecutionsResult> |
listExecutionsAsync(ListExecutionsRequest request)
Lists all executions for the specified workflow.
|
Future<ListExecutionsResult> |
listExecutionsAsync(ListExecutionsRequest request,
AsyncHandler<ListExecutionsRequest,ListExecutionsResult> asyncHandler)
Lists all executions for the specified workflow.
|
Future<ListSecurityPoliciesResult> |
listSecurityPoliciesAsync(ListSecurityPoliciesRequest request)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
|
Future<ListSecurityPoliciesResult> |
listSecurityPoliciesAsync(ListSecurityPoliciesRequest request,
AsyncHandler<ListSecurityPoliciesRequest,ListSecurityPoliciesResult> asyncHandler)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
|
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 of your workflows.
|
Future<ListWorkflowsResult> |
listWorkflowsAsync(ListWorkflowsRequest request,
AsyncHandler<ListWorkflowsRequest,ListWorkflowsResult> asyncHandler)
Lists all of your workflows.
|
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.
|
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<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<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.
|
createAccess, createServer, createUser, createWorkflow, deleteAccess, deleteServer, deleteSshPublicKey, deleteUser, deleteWorkflow, describeAccess, describeExecution, describeSecurityPolicy, describeServer, describeUser, describeWorkflow, getCachedResponseMetadata, importSshPublicKey, listAccesses, listExecutions, listSecurityPolicies, listServers, listTagsForResource, listUsers, listWorkflows, sendWorkflowStepState, shutdown, startServer, stopServer, tagResource, testIdentityProvider, untagResource, updateAccess, updateServer, updateUser, waitersclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateAccess, createServer, createUser, createWorkflow, deleteAccess, deleteServer, deleteSshPublicKey, deleteUser, deleteWorkflow, describeAccess, describeExecution, describeSecurityPolicy, describeServer, describeUser, describeWorkflow, getCachedResponseMetadata, importSshPublicKey, listAccesses, listExecutions, listSecurityPolicies, listServers, listTagsForResource, listUsers, listWorkflows, sendWorkflowStepState, shutdown, startServer, stopServer, tagResource, testIdentityProvider, untagResource, updateAccess, updateServer, updateUser, waiterspublic 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 Amazon Web Services 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 AWSTransferAsyncpublic 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 Amazon Web Services 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 AWSTransferAsyncasyncHandler - 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 AWSTransferAsyncpublic 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 AWSTransferAsyncasyncHandler - 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 Amazon Web Services 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 AWSTransferAsyncpublic 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 Amazon Web Services 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 AWSTransferAsyncasyncHandler - 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 AWSTransferAsyncpublic 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 AWSTransferAsyncasyncHandler - 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 AWSTransferAsyncpublic 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 AWSTransferAsyncasyncHandler - 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)
AWSTransferAsyncDeletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.
deleteServerAsync in interface AWSTransferAsyncpublic Future<DeleteServerResult> deleteServerAsync(DeleteServerRequest request, AsyncHandler<DeleteServerRequest,DeleteServerResult> asyncHandler)
AWSTransferAsyncDeletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.
deleteServerAsync in interface AWSTransferAsyncasyncHandler - 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)
AWSTransferAsyncDeletes a user's Secure Shell (SSH) public key.
deleteSshPublicKeyAsync in interface AWSTransferAsyncpublic Future<DeleteSshPublicKeyResult> deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest request, AsyncHandler<DeleteSshPublicKeyRequest,DeleteSshPublicKeyResult> asyncHandler)
AWSTransferAsyncDeletes a user's Secure Shell (SSH) public key.
deleteSshPublicKeyAsync in interface AWSTransferAsyncasyncHandler - 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)
AWSTransferAsyncDeletes 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 AWSTransferAsyncpublic Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
AWSTransferAsyncDeletes 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 AWSTransferAsyncasyncHandler - 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)
AWSTransferAsyncDeletes the specified workflow.
deleteWorkflowAsync in interface AWSTransferAsyncpublic Future<DeleteWorkflowResult> deleteWorkflowAsync(DeleteWorkflowRequest request, AsyncHandler<DeleteWorkflowRequest,DeleteWorkflowResult> asyncHandler)
AWSTransferAsyncDeletes the specified workflow.
deleteWorkflowAsync in interface AWSTransferAsyncasyncHandler - 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 AWSTransferAsyncpublic 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 AWSTransferAsyncasyncHandler - 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.
describeExecutionAsync in interface AWSTransferAsyncpublic 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.
describeExecutionAsync in interface AWSTransferAsyncasyncHandler - 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)
AWSTransferAsyncDescribes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies.
describeSecurityPolicyAsync in interface AWSTransferAsyncpublic Future<DescribeSecurityPolicyResult> describeSecurityPolicyAsync(DescribeSecurityPolicyRequest request, AsyncHandler<DescribeSecurityPolicyRequest,DescribeSecurityPolicyResult> asyncHandler)
AWSTransferAsyncDescribes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies.
describeSecurityPolicyAsync in interface AWSTransferAsyncasyncHandler - 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 AWSTransferAsyncpublic 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 AWSTransferAsyncasyncHandler - 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 AWSTransferAsyncpublic 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 AWSTransferAsyncasyncHandler - 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)
AWSTransferAsyncDescribes the specified workflow.
describeWorkflowAsync in interface AWSTransferAsyncpublic Future<DescribeWorkflowResult> describeWorkflowAsync(DescribeWorkflowRequest request, AsyncHandler<DescribeWorkflowRequest,DescribeWorkflowResult> asyncHandler)
AWSTransferAsyncDescribes the specified workflow.
describeWorkflowAsync in interface AWSTransferAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ImportSshPublicKeyResult> importSshPublicKeyAsync(ImportSshPublicKeyRequest request)
AWSTransferAsync
Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to
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 AWSTransferAsyncpublic Future<ImportSshPublicKeyResult> importSshPublicKeyAsync(ImportSshPublicKeyRequest request, AsyncHandler<ImportSshPublicKeyRequest,ImportSshPublicKeyResult> asyncHandler)
AWSTransferAsync
Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to
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 AWSTransferAsyncasyncHandler - 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)
AWSTransferAsyncLists the details for all the accesses you have on your server.
listAccessesAsync in interface AWSTransferAsyncpublic Future<ListAccessesResult> listAccessesAsync(ListAccessesRequest request, AsyncHandler<ListAccessesRequest,ListAccessesResult> asyncHandler)
AWSTransferAsyncLists the details for all the accesses you have on your server.
listAccessesAsync in interface AWSTransferAsyncasyncHandler - 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)
AWSTransferAsyncLists all executions for the specified workflow.
listExecutionsAsync in interface AWSTransferAsyncpublic Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest request, AsyncHandler<ListExecutionsRequest,ListExecutionsResult> asyncHandler)
AWSTransferAsyncLists all executions for the specified workflow.
listExecutionsAsync in interface AWSTransferAsyncasyncHandler - 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)
AWSTransferAsyncLists the security policies that are attached to your file transfer protocol-enabled servers.
listSecurityPoliciesAsync in interface AWSTransferAsyncpublic Future<ListSecurityPoliciesResult> listSecurityPoliciesAsync(ListSecurityPoliciesRequest request, AsyncHandler<ListSecurityPoliciesRequest,ListSecurityPoliciesResult> asyncHandler)
AWSTransferAsyncLists the security policies that are attached to your file transfer protocol-enabled servers.
listSecurityPoliciesAsync in interface AWSTransferAsyncasyncHandler - 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)
AWSTransferAsyncLists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
listServersAsync in interface AWSTransferAsyncpublic Future<ListServersResult> listServersAsync(ListServersRequest request, AsyncHandler<ListServersRequest,ListServersResult> asyncHandler)
AWSTransferAsyncLists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
listServersAsync in interface AWSTransferAsyncasyncHandler - 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)
AWSTransferAsyncLists 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 AWSTransferAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSTransferAsyncLists 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 AWSTransferAsyncasyncHandler - 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 AWSTransferAsyncpublic 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 AWSTransferAsyncasyncHandler - 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)
AWSTransferAsyncLists all of your workflows.
listWorkflowsAsync in interface AWSTransferAsyncpublic Future<ListWorkflowsResult> listWorkflowsAsync(ListWorkflowsRequest request, AsyncHandler<ListWorkflowsRequest,ListWorkflowsResult> asyncHandler)
AWSTransferAsyncLists all of your workflows.
listWorkflowsAsync in interface AWSTransferAsyncasyncHandler - 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)
AWSTransferAsyncSends 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 AWSTransferAsyncpublic Future<SendWorkflowStepStateResult> sendWorkflowStepStateAsync(SendWorkflowStepStateRequest request, AsyncHandler<SendWorkflowStepStateRequest,SendWorkflowStepStateResult> asyncHandler)
AWSTransferAsyncSends 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 AWSTransferAsyncasyncHandler - 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 AWSTransferAsyncpublic 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 AWSTransferAsyncasyncHandler - 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 will 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 AWSTransferAsyncpublic 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 will 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 AWSTransferAsyncasyncHandler - 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)
AWSTransferAsyncAttaches 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 AWSTransferAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSTransferAsyncAttaches 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 AWSTransferAsyncasyncHandler - 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.
You cannot use TestIdentityProvider if the IdentityProviderType of your server is
SERVICE_MANAGED.
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
testIdentityProviderAsync in interface AWSTransferAsyncpublic 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.
You cannot use TestIdentityProvider if the IdentityProviderType of your server is
SERVICE_MANAGED.
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
testIdentityProviderAsync in interface AWSTransferAsyncasyncHandler - 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)
AWSTransferAsyncDetaches 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 AWSTransferAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSTransferAsyncDetaches 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 AWSTransferAsyncasyncHandler - 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 AWSTransferAsyncpublic 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 AWSTransferAsyncasyncHandler - 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)
AWSTransferAsyncUpdates 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 AWSTransferAsyncpublic Future<UpdateServerResult> updateServerAsync(UpdateServerRequest request, AsyncHandler<UpdateServerRequest,UpdateServerResult> asyncHandler)
AWSTransferAsyncUpdates 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 AWSTransferAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request)
AWSTransferAsync
Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory,
role, and policy for the UserName and ServerId you specify.
The response returns the ServerId and the UserName for the updated user.
updateUserAsync in interface AWSTransferAsyncpublic Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
AWSTransferAsync
Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory,
role, and policy for the UserName and ServerId you specify.
The response returns the ServerId and the UserName for the updated user.
updateUserAsync in interface AWSTransferAsyncasyncHandler - 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.Copyright © 2022. All rights reserved.