| Package | Description |
|---|---|
| software.amazon.awssdk.services.transfer |
Amazon Web Services 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).
|
| software.amazon.awssdk.services.transfer.model |
| Modifier and Type | Method and Description |
|---|---|
default CreateAccessResponse |
TransferClient.createAccess(Consumer<CreateAccessRequest.Builder> createAccessRequest)
Used by administrators to choose which groups in the directory should have access to upload and download files
over the enabled protocols using Amazon Web Services Transfer Family.
|
default CreateAccessResponse |
TransferClient.createAccess(CreateAccessRequest createAccessRequest)
Used by administrators to choose which groups in the directory should have access to upload and download files
over the enabled protocols using Amazon Web Services Transfer Family.
|
default CreateServerResponse |
TransferClient.createServer(Consumer<CreateServerRequest.Builder> createServerRequest)
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.
|
default CreateServerResponse |
TransferClient.createServer(CreateServerRequest createServerRequest)
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.
|
default CreateUserResponse |
TransferClient.createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user and associates them with an existing file transfer protocol-enabled server.
|
default CreateUserResponse |
TransferClient.createUser(CreateUserRequest createUserRequest)
Creates a user and associates them with an existing file transfer protocol-enabled server.
|
default CreateWorkflowResponse |
TransferClient.createWorkflow(Consumer<CreateWorkflowRequest.Builder> createWorkflowRequest)
Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer
completes.
|
default CreateWorkflowResponse |
TransferClient.createWorkflow(CreateWorkflowRequest createWorkflowRequest)
Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer
completes.
|
default DeleteAccessResponse |
TransferClient.deleteAccess(Consumer<DeleteAccessRequest.Builder> deleteAccessRequest)
Allows you to delete the access specified in the
ServerID and ExternalID parameters. |
default DeleteAccessResponse |
TransferClient.deleteAccess(DeleteAccessRequest deleteAccessRequest)
Allows you to delete the access specified in the
ServerID and ExternalID parameters. |
default DeleteServerResponse |
TransferClient.deleteServer(Consumer<DeleteServerRequest.Builder> deleteServerRequest)
Deletes the file transfer protocol-enabled server that you specify.
|
default DeleteServerResponse |
TransferClient.deleteServer(DeleteServerRequest deleteServerRequest)
Deletes the file transfer protocol-enabled server that you specify.
|
default DeleteSshPublicKeyResponse |
TransferClient.deleteSshPublicKey(Consumer<DeleteSshPublicKeyRequest.Builder> deleteSshPublicKeyRequest)
Deletes a user's Secure Shell (SSH) public key.
|
default DeleteSshPublicKeyResponse |
TransferClient.deleteSshPublicKey(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest)
Deletes a user's Secure Shell (SSH) public key.
|
default DeleteUserResponse |
TransferClient.deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes the user belonging to a file transfer protocol-enabled server you specify.
|
default DeleteUserResponse |
TransferClient.deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the user belonging to a file transfer protocol-enabled server you specify.
|
default DeleteWorkflowResponse |
TransferClient.deleteWorkflow(Consumer<DeleteWorkflowRequest.Builder> deleteWorkflowRequest)
Deletes the specified workflow.
|
default DeleteWorkflowResponse |
TransferClient.deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest)
Deletes the specified workflow.
|
default DescribeAccessResponse |
TransferClient.describeAccess(Consumer<DescribeAccessRequest.Builder> describeAccessRequest)
Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property and its ExternalID. |
default DescribeAccessResponse |
TransferClient.describeAccess(DescribeAccessRequest describeAccessRequest)
Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property and its ExternalID. |
default DescribeExecutionResponse |
TransferClient.describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest)
You can use
DescribeExecution to check the details of the execution of the specified workflow. |
default DescribeExecutionResponse |
TransferClient.describeExecution(DescribeExecutionRequest describeExecutionRequest)
You can use
DescribeExecution to check the details of the execution of the specified workflow. |
default DescribeSecurityPolicyResponse |
TransferClient.describeSecurityPolicy(Consumer<DescribeSecurityPolicyRequest.Builder> describeSecurityPolicyRequest)
Describes the security policy that is attached to your file transfer protocol-enabled server.
|
default DescribeSecurityPolicyResponse |
TransferClient.describeSecurityPolicy(DescribeSecurityPolicyRequest describeSecurityPolicyRequest)
Describes the security policy that is attached to your file transfer protocol-enabled server.
|
default DescribeServerResponse |
TransferClient.describeServer(Consumer<DescribeServerRequest.Builder> describeServerRequest)
Describes a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
default DescribeServerResponse |
TransferClient.describeServer(DescribeServerRequest describeServerRequest)
Describes a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
default DescribeUserResponse |
TransferClient.describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property. |
default DescribeUserResponse |
TransferClient.describeUser(DescribeUserRequest describeUserRequest)
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property. |
default DescribeWorkflowResponse |
TransferClient.describeWorkflow(Consumer<DescribeWorkflowRequest.Builder> describeWorkflowRequest)
Describes the specified workflow.
|
default DescribeWorkflowResponse |
TransferClient.describeWorkflow(DescribeWorkflowRequest describeWorkflowRequest)
Describes the specified workflow.
|
default ImportSshPublicKeyResponse |
TransferClient.importSshPublicKey(Consumer<ImportSshPublicKeyRequest.Builder> importSshPublicKeyRequest)
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. |
default ImportSshPublicKeyResponse |
TransferClient.importSshPublicKey(ImportSshPublicKeyRequest importSshPublicKeyRequest)
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. |
default ListAccessesResponse |
TransferClient.listAccesses(Consumer<ListAccessesRequest.Builder> listAccessesRequest)
Lists the details for all the accesses you have on your server.
|
default ListAccessesResponse |
TransferClient.listAccesses(ListAccessesRequest listAccessesRequest)
Lists the details for all the accesses you have on your server.
|
default ListAccessesIterable |
TransferClient.listAccessesPaginator(Consumer<ListAccessesRequest.Builder> listAccessesRequest)
Lists the details for all the accesses you have on your server.
|
default ListAccessesIterable |
TransferClient.listAccessesPaginator(ListAccessesRequest listAccessesRequest)
Lists the details for all the accesses you have on your server.
|
default ListExecutionsResponse |
TransferClient.listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Lists all executions for the specified workflow.
|
default ListExecutionsResponse |
TransferClient.listExecutions(ListExecutionsRequest listExecutionsRequest)
Lists all executions for the specified workflow.
|
default ListExecutionsIterable |
TransferClient.listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Lists all executions for the specified workflow.
|
default ListExecutionsIterable |
TransferClient.listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)
Lists all executions for the specified workflow.
|
default ListSecurityPoliciesResponse |
TransferClient.listSecurityPolicies(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
|
default ListSecurityPoliciesResponse |
TransferClient.listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
|
default ListSecurityPoliciesIterable |
TransferClient.listSecurityPoliciesPaginator(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
|
default ListSecurityPoliciesIterable |
TransferClient.listSecurityPoliciesPaginator(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
|
default ListServersResponse |
TransferClient.listServers()
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
|
default ListServersResponse |
TransferClient.listServers(Consumer<ListServersRequest.Builder> listServersRequest)
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
|
default ListServersResponse |
TransferClient.listServers(ListServersRequest listServersRequest)
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
|
default ListServersIterable |
TransferClient.listServersPaginator()
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
|
default ListServersIterable |
TransferClient.listServersPaginator(Consumer<ListServersRequest.Builder> listServersRequest)
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
|
default ListServersIterable |
TransferClient.listServersPaginator(ListServersRequest listServersRequest)
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
|
default ListTagsForResourceResponse |
TransferClient.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
|
default ListTagsForResourceResponse |
TransferClient.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
|
default ListTagsForResourceIterable |
TransferClient.listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
|
default ListTagsForResourceIterable |
TransferClient.listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
|
default ListUsersResponse |
TransferClient.listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
default ListUsersResponse |
TransferClient.listUsers(ListUsersRequest listUsersRequest)
Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
default ListUsersIterable |
TransferClient.listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
default ListUsersIterable |
TransferClient.listUsersPaginator(ListUsersRequest listUsersRequest)
Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
default ListWorkflowsResponse |
TransferClient.listWorkflows(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest)
Lists all of your workflows.
|
default ListWorkflowsResponse |
TransferClient.listWorkflows(ListWorkflowsRequest listWorkflowsRequest)
Lists all of your workflows.
|
default ListWorkflowsIterable |
TransferClient.listWorkflowsPaginator(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest)
Lists all of your workflows.
|
default ListWorkflowsIterable |
TransferClient.listWorkflowsPaginator(ListWorkflowsRequest listWorkflowsRequest)
Lists all of your workflows.
|
default SendWorkflowStepStateResponse |
TransferClient.sendWorkflowStepState(Consumer<SendWorkflowStepStateRequest.Builder> sendWorkflowStepStateRequest)
Sends a callback for asynchronous custom steps.
|
default SendWorkflowStepStateResponse |
TransferClient.sendWorkflowStepState(SendWorkflowStepStateRequest sendWorkflowStepStateRequest)
Sends a callback for asynchronous custom steps.
|
default StartServerResponse |
TransferClient.startServer(Consumer<StartServerRequest.Builder> startServerRequest)
Changes the state of a file transfer protocol-enabled server from
OFFLINE to ONLINE. |
default StartServerResponse |
TransferClient.startServer(StartServerRequest startServerRequest)
Changes the state of a file transfer protocol-enabled server from
OFFLINE to ONLINE. |
default StopServerResponse |
TransferClient.stopServer(Consumer<StopServerRequest.Builder> stopServerRequest)
Changes the state of a file transfer protocol-enabled server from
ONLINE to OFFLINE. |
default StopServerResponse |
TransferClient.stopServer(StopServerRequest stopServerRequest)
Changes the state of a file transfer protocol-enabled server from
ONLINE to OFFLINE. |
default TagResourceResponse |
TransferClient.tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
|
default TagResourceResponse |
TransferClient.tagResource(TagResourceRequest tagResourceRequest)
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
|
default TestIdentityProviderResponse |
TransferClient.testIdentityProvider(Consumer<TestIdentityProviderRequest.Builder> testIdentityProviderRequest)
If the
IdentityProviderType of a file transfer protocol-enabled server is
AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up
successfully. |
default TestIdentityProviderResponse |
TransferClient.testIdentityProvider(TestIdentityProviderRequest testIdentityProviderRequest)
If the
IdentityProviderType of a file transfer protocol-enabled server is
AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up
successfully. |
default UntagResourceResponse |
TransferClient.untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
|
default UntagResourceResponse |
TransferClient.untagResource(UntagResourceRequest untagResourceRequest)
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
|
default UpdateAccessResponse |
TransferClient.updateAccess(Consumer<UpdateAccessRequest.Builder> updateAccessRequest)
Allows you to update parameters for the access specified in the
ServerID and ExternalID
parameters. |
default UpdateAccessResponse |
TransferClient.updateAccess(UpdateAccessRequest updateAccessRequest)
Allows you to update parameters for the access specified in the
ServerID and ExternalID
parameters. |
default UpdateServerResponse |
TransferClient.updateServer(Consumer<UpdateServerRequest.Builder> updateServerRequest)
Updates the file transfer protocol-enabled server's properties after that server has been created.
|
default UpdateServerResponse |
TransferClient.updateServer(UpdateServerRequest updateServerRequest)
Updates the file transfer protocol-enabled server's properties after that server has been created.
|
default UpdateUserResponse |
TransferClient.updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
Assigns new properties to a user.
|
default UpdateUserResponse |
TransferClient.updateUser(UpdateUserRequest updateUserRequest)
Assigns new properties to a user.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AccessDeniedException
You do not have sufficient access to perform this action.
|
class |
ConflictException
This exception is thrown when the
UpdateServer is called for a file transfer protocol-enabled server
that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state. |
class |
InternalServiceErrorException
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
|
class |
InvalidNextTokenException
The
NextToken parameter that was passed is invalid. |
class |
InvalidRequestException
This exception is thrown when the client submits a malformed request.
|
class |
ResourceExistsException
The requested resource does not exist.
|
class |
ResourceNotFoundException
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
|
class |
ServiceUnavailableException
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
|
class |
ThrottlingException
The request was denied due to request throttling.
|
| Modifier and Type | Method and Description |
|---|---|
TransferException |
TransferException.BuilderImpl.build() |
| Constructor and Description |
|---|
BuilderImpl(TransferException ex) |
Copyright © 2022. All rights reserved.