@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSTransfer
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSTransfer instead.
AWS 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). AWS helps you seamlessly migrate your file transfer workflows to AWS 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 AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer Family is easy since there is no infrastructure to buy and set up.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CreateServerResult |
createServer(CreateServerRequest createServerRequest)
Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS.
|
CreateUserResult |
createUser(CreateUserRequest createUserRequest)
Creates a user and associates them with an existing file transfer protocol-enabled server.
|
DeleteServerResult |
deleteServer(DeleteServerRequest deleteServerRequest)
Deletes the file transfer protocol-enabled server that you specify.
|
DeleteSshPublicKeyResult |
deleteSshPublicKey(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest)
Deletes a user's Secure Shell (SSH) public key.
|
DeleteUserResult |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the user belonging to a file transfer protocol-enabled server you specify.
|
DescribeSecurityPolicyResult |
describeSecurityPolicy(DescribeSecurityPolicyRequest describeSecurityPolicyRequest)
Describes the security policy that is attached to your file transfer protocol-enabled server.
|
DescribeServerResult |
describeServer(DescribeServerRequest describeServerRequest)
Describes a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
DescribeUserResult |
describeUser(DescribeUserRequest describeUserRequest)
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property. |
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ImportSshPublicKeyResult |
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. |
ListSecurityPoliciesResult |
listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
|
ListServersResult |
listServers(ListServersRequest listServersRequest)
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify.
|
ListUsersResult |
listUsers(ListUsersRequest listUsersRequest)
Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartServerResult |
startServer(StartServerRequest startServerRequest)
Changes the state of a file transfer protocol-enabled server from
OFFLINE to ONLINE. |
StopServerResult |
stopServer(StopServerRequest stopServerRequest)
Changes the state of a file transfer protocol-enabled server from
ONLINE to OFFLINE. |
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
|
TestIdentityProviderResult |
testIdentityProvider(TestIdentityProviderRequest testIdentityProviderRequest)
If the
IdentityProviderType of a file transfer protocol-enabled server is API_Gateway,
tests whether your API Gateway is set up successfully. |
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
|
UpdateServerResult |
updateServer(UpdateServerRequest updateServerRequest)
Updates the file transfer protocol-enabled server's properties after that server has been created.
|
UpdateUserResult |
updateUser(UpdateUserRequest updateUserRequest)
Assigns new properties to a user.
|
static final String ENDPOINT_PREFIX
CreateServerResult createServer(CreateServerRequest createServerRequest)
Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS. 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.
createServerRequest - AccessDeniedException - You do not have sufficient access to perform this action.ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceExistsException - The requested resource does not exist.ThrottlingException - The request was denied due to request throttling.
HTTP Status Code: 400
CreateUserResult createUser(CreateUserRequest createUserRequest)
Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create
and associate users with servers that have the IdentityProviderType set to
SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set
the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM)
role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group
and search for users.
createUserRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceExistsException - The requested resource does not exist.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.DeleteServerResult deleteServer(DeleteServerRequest deleteServerRequest)
Deletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.
deleteServerRequest - AccessDeniedException - You do not have sufficient access to perform this action.ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.DeleteSshPublicKeyResult deleteSshPublicKey(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest)
Deletes a user's Secure Shell (SSH) public key.
No response is returned from this operation.
deleteSshPublicKeyRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.ThrottlingException - The request was denied due to request throttling.
HTTP Status Code: 400
DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the user belonging to a file transfer protocol-enabled server you specify.
No response returns from this operation.
When you delete a user from a server, the user's information is lost.
deleteUserRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.DescribeSecurityPolicyResult describeSecurityPolicy(DescribeSecurityPolicyRequest describeSecurityPolicyRequest)
Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies.
describeSecurityPolicyRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.DescribeServerResult describeServer(DescribeServerRequest describeServerRequest)
Describes a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
The response contains a description of a server's properties. When you set EndpointType to VPC, the
response will contain the EndpointDetails.
describeServerRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.DescribeUserResult describeUser(DescribeUserRequest describeUserRequest)
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property.
The response from this call returns the properties of the user associated with the ServerId value
that was specified.
describeUserRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.ImportSshPublicKeyResult 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.
The response returns the UserName value, the ServerId value, and the name of the
SshPublicKeyId.
importSshPublicKeyRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceExistsException - The requested resource does not exist.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.ThrottlingException - The request was denied due to request throttling.
HTTP Status Code: 400
ListSecurityPoliciesResult listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
listSecurityPoliciesRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidNextTokenException - The NextToken parameter that was passed is invalid.InvalidRequestException - This exception is thrown when the client submits a malformed request.ListServersResult listServers(ListServersRequest listServersRequest)
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
listServersRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidNextTokenException - The NextToken parameter that was passed is invalid.InvalidRequestException - This exception is thrown when the client submits a malformed request.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.
listTagsForResourceRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidNextTokenException - The NextToken parameter that was passed is invalid.InvalidRequestException - This exception is thrown when the client submits a malformed request.ListUsersResult listUsers(ListUsersRequest listUsersRequest)
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
listUsersRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidNextTokenException - The NextToken parameter that was passed is invalid.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.StartServerResult startServer(StartServerRequest startServerRequest)
Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It
has no impact on a server that is already ONLINE. An ONLINE server can accept and
process file transfer jobs.
The state of STARTING indicates that the server is in an intermediate state, either not fully able
to respond, or not fully online. The values of START_FAILED can indicate an error condition.
No response is returned from this call.
startServerRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.ThrottlingException - The request was denied due to request throttling.
HTTP Status Code: 400
StopServerResult stopServer(StopServerRequest stopServerRequest)
Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An
OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such
as server and user properties, are not affected by stopping your server.
Stopping the server 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.
stopServerRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.ThrottlingException - The request was denied due to request throttling.
HTTP Status Code: 400
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
There is no response returned from this call.
tagResourceRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.TestIdentityProviderResult testIdentityProvider(TestIdentityProviderRequest testIdentityProviderRequest)
If the IdentityProviderType of a file transfer protocol-enabled server is API_Gateway,
tests whether your API Gateway 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
API Gateway integration to ensure that your users can successfully use the service.
testIdentityProviderRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
No response is returned from this call.
untagResourceRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.UpdateServerResult updateServer(UpdateServerRequest updateServerRequest)
Updates the file transfer protocol-enabled server's properties after that server has been created.
The UpdateServer call returns the ServerId of the server you updated.
updateServerRequest - AccessDeniedException - You do not have sufficient access to perform this action.ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.ConflictException - This exception is thrown when the UpdatServer 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.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceExistsException - The requested resource does not exist.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.ThrottlingException - The request was denied due to request throttling.
HTTP Status Code: 400
UpdateUserResult updateUser(UpdateUserRequest updateUserRequest)
Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory,
role, and policy for the UserName and ServerId you specify.
The response returns the ServerId and the UserName for the updated user.
updateUserRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.ThrottlingException - The request was denied due to request throttling.
HTTP Status Code: 400
void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.