@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSTransferClient extends AmazonWebServiceClient implements AWSTransfer
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
static AWSTransferClientBuilder |
builder() |
CreateServerResult |
createServer(CreateServerRequest request)
Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS.
|
CreateUserResult |
createUser(CreateUserRequest request)
Creates a user and associates them with an existing file transfer protocol-enabled server.
|
DeleteServerResult |
deleteServer(DeleteServerRequest request)
Deletes the file transfer protocol-enabled server that you specify.
|
DeleteSshPublicKeyResult |
deleteSshPublicKey(DeleteSshPublicKeyRequest request)
Deletes a user's Secure Shell (SSH) public key.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
Deletes the user belonging to a file transfer protocol-enabled server you specify.
|
DescribeSecurityPolicyResult |
describeSecurityPolicy(DescribeSecurityPolicyRequest request)
Describes the security policy that is attached to your file transfer protocol-enabled server.
|
DescribeServerResult |
describeServer(DescribeServerRequest request)
Describes a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
DescribeUserResult |
describeUser(DescribeUserRequest request)
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 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 . |
ListSecurityPoliciesResult |
listSecurityPolicies(ListSecurityPoliciesRequest request)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
|
ListServersResult |
listServers(ListServersRequest request)
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify.
|
ListUsersResult |
listUsers(ListUsersRequest request)
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 request)
Changes the state of a file transfer protocol-enabled server from
OFFLINE to ONLINE . |
StopServerResult |
stopServer(StopServerRequest request)
Changes the state of a file transfer protocol-enabled server from
ONLINE to OFFLINE . |
TagResourceResult |
tagResource(TagResourceRequest request)
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
|
TestIdentityProviderResult |
testIdentityProvider(TestIdentityProviderRequest request)
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 request)
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
|
UpdateServerResult |
updateServer(UpdateServerRequest request)
Updates the file transfer protocol-enabled server's properties after that server has been created.
|
UpdateUserResult |
updateUser(UpdateUserRequest request)
Assigns new properties to a user.
|
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
public static AWSTransferClientBuilder builder()
public CreateServerResult createServer(CreateServerRequest request)
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.
createServer
in interface AWSTransfer
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
public CreateUserResult createUser(CreateUserRequest request)
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.
createUser
in interface AWSTransfer
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.public DeleteServerResult deleteServer(DeleteServerRequest request)
Deletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.
deleteServer
in interface AWSTransfer
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.public DeleteSshPublicKeyResult deleteSshPublicKey(DeleteSshPublicKeyRequest request)
Deletes a user's Secure Shell (SSH) public key.
No response is returned from this operation.
deleteSshPublicKey
in interface AWSTransfer
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
public DeleteUserResult deleteUser(DeleteUserRequest request)
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.
deleteUser
in interface AWSTransfer
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.public DescribeSecurityPolicyResult describeSecurityPolicy(DescribeSecurityPolicyRequest request)
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.
describeSecurityPolicy
in interface AWSTransfer
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.public DescribeServerResult describeServer(DescribeServerRequest request)
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
.
describeServer
in interface AWSTransfer
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.public DescribeUserResult describeUser(DescribeUserRequest request)
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.
describeUser
in interface AWSTransfer
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.public ImportSshPublicKeyResult importSshPublicKey(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
.
The response returns the UserName
value, the ServerId
value, and the name of the
SshPublicKeyId
.
importSshPublicKey
in interface AWSTransfer
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
public ListSecurityPoliciesResult listSecurityPolicies(ListSecurityPoliciesRequest request)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
listSecurityPolicies
in interface AWSTransfer
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.public ListServersResult listServers(ListServersRequest request)
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
listServers
in interface AWSTransfer
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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.
listTagsForResource
in interface AWSTransfer
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.public ListUsersResult listUsers(ListUsersRequest request)
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
listUsers
in interface AWSTransfer
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.public StartServerResult startServer(StartServerRequest request)
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.
startServer
in interface AWSTransfer
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
public StopServerResult stopServer(StopServerRequest request)
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.
stopServer
in interface AWSTransfer
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
public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource
in interface AWSTransfer
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.public TestIdentityProviderResult testIdentityProvider(TestIdentityProviderRequest request)
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.
testIdentityProvider
in interface AWSTransfer
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.public UntagResourceResult untagResource(UntagResourceRequest request)
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.
untagResource
in interface AWSTransfer
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.public UpdateServerResult updateServer(UpdateServerRequest request)
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.
updateServer
in interface AWSTransfer
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
public UpdateUserResult updateUser(UpdateUserRequest request)
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.
updateUser
in interface AWSTransfer
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
public 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 the request.
getCachedResponseMetadata
in interface AWSTransfer
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSTransfer
shutdown
in class AmazonWebServiceClient