AWSTransfer (AWS SDK for Java

All Known Subinterfaces:

AWSTransferAsync

All Known Implementing Classes:

AbstractAWSTransfer, AbstractAWSTransferAsync, AWSTransferAsyncClient, AWSTransferClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSTransfer
```
Interface for accessing AWS Transfer.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSTransfer instead.

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). Amazon Web Services helps you seamlessly migrate your file transfer workflows to Amazon Web Services Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning, and archiving. Getting started with Amazon Web Services Transfer Family is easy since there is no infrastructure to buy and set up.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreateAccessResult`	`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.
`CreateServerResult`	`createServer(CreateServerRequest createServerRequest)` Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.
`CreateUserResult`	`createUser(CreateUserRequest createUserRequest)` Creates a user and associates them with an existing file transfer protocol-enabled server.
`CreateWorkflowResult`	`createWorkflow(CreateWorkflowRequest createWorkflowRequest)` Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.
`DeleteAccessResult`	`deleteAccess(DeleteAccessRequest deleteAccessRequest)` Allows you to delete the access specified in the `ServerID` and `ExternalID` parameters.
`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.
`DeleteWorkflowResult`	`deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest)` Deletes the specified workflow.
`DescribeAccessResult`	`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`.
`DescribeExecutionResult`	`describeExecution(DescribeExecutionRequest describeExecutionRequest)` You can use `DescribeExecution` to check the details of the execution of the specified workflow.
`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.
`DescribeWorkflowResult`	`describeWorkflow(DescribeWorkflowRequest describeWorkflowRequest)` Describes the specified workflow.
`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`.
`ListAccessesResult`	`listAccesses(ListAccessesRequest listAccessesRequest)` Lists the details for all the accesses you have on your server.
`ListExecutionsResult`	`listExecutions(ListExecutionsRequest listExecutionsRequest)` Lists all executions for the specified workflow.
`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 Amazon Web Services account.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
`ListUsersResult`	`listUsers(ListUsersRequest listUsersRequest)` Lists the users for a file transfer protocol-enabled server that you specify by passing the `ServerId` parameter.
`ListWorkflowsResult`	`listWorkflows(ListWorkflowsRequest listWorkflowsRequest)` Lists all of your workflows.
`SendWorkflowStepStateResult`	`sendWorkflowStepState(SendWorkflowStepStateRequest sendWorkflowStepStateRequest)` Sends a callback for asynchronous custom steps.
`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 `AWS_DIRECTORY_SERVICE` or `API_Gateway`, tests whether your identity provider is set up successfully.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
`UpdateAccessResult`	`updateAccess(UpdateAccessRequest updateAccessRequest)` Allows you to update parameters for the access specified in the `ServerID` and `ExternalID` parameters.
`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.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - createAccess
```
CreateAccessResult 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. 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.
    
    Parameters:
    
    createAccessRequest -
    
    Returns:
    
    Result of the CreateAccess operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    See Also:
    
    AWS API Documentation
  - createServer
```
CreateServerResult createServer(CreateServerRequest createServerRequest)
```
    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.
    
    Parameters:
    
    createServerRequest -
    
    Returns:
    
    Result of the CreateServer operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    HTTP Status Code: 400
    
    See Also:
    
    AWS API Documentation
  - createUser
```
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 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.
    
    Parameters:
    
    createUserRequest -
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    See Also:
    
    AWS API Documentation
  - createWorkflow
```
CreateWorkflowResult createWorkflow(CreateWorkflowRequest createWorkflowRequest)
```
    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.
    
    Parameters:
    
    createWorkflowRequest -
    
    Returns:
    
    Result of the CreateWorkflow operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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
    
    See Also:
    
    AWS API Documentation
  - deleteAccess
```
DeleteAccessResult deleteAccess(DeleteAccessRequest deleteAccessRequest)
```
    Allows you to delete the access specified in the ServerID and ExternalID parameters.
    
    Parameters:
    
    deleteAccessRequest -
    
    Returns:
    
    Result of the DeleteAccess operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    See Also:
    
    AWS API Documentation
  - deleteServer
```
DeleteServerResult deleteServer(DeleteServerRequest deleteServerRequest)
```
    Deletes the file transfer protocol-enabled server that you specify.
    
    No response returns from this operation.
    
    Parameters:
    
    deleteServerRequest -
    
    Returns:
    
    Result of the DeleteServer operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    See Also:
    
    AWS API Documentation
  - deleteSshPublicKey
```
DeleteSshPublicKeyResult deleteSshPublicKey(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest)
```
    Deletes a user's Secure Shell (SSH) public key.
    
    Parameters:
    
    deleteSshPublicKeyRequest -
    
    Returns:
    
    Result of the DeleteSshPublicKey operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    HTTP Status Code: 400
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
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.
    
    Parameters:
    
    deleteUserRequest -
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    See Also:
    
    AWS API Documentation
  - deleteWorkflow
```
DeleteWorkflowResult deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest)
```
    Deletes the specified workflow.
    
    Parameters:
    
    deleteWorkflowRequest -
    
    Returns:
    
    Result of the DeleteWorkflow operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    See Also:
    
    AWS API Documentation
  - describeAccess
```
DescribeAccessResult 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.
    
    The response from this call returns the properties of the access that is associated with the ServerId value that was specified.
    
    Parameters:
    
    describeAccessRequest -
    
    Returns:
    
    Result of the DescribeAccess operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    See Also:
    
    AWS API Documentation
  - describeExecution
```
DescribeExecutionResult describeExecution(DescribeExecutionRequest describeExecutionRequest)
```
    You can use DescribeExecution to check the details of the execution of the specified workflow.
    
    Parameters:
    
    describeExecutionRequest -
    
    Returns:
    
    Result of the DescribeExecution operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    See Also:
    
    AWS API Documentation
  - describeSecurityPolicy
```
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.
    
    Parameters:
    
    describeSecurityPolicyRequest -
    
    Returns:
    
    Result of the DescribeSecurityPolicy operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    See Also:
    
    AWS API Documentation
  - describeServer
```
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.
    
    Parameters:
    
    describeServerRequest -
    
    Returns:
    
    Result of the DescribeServer operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    See Also:
    
    AWS API Documentation
  - describeUser
```
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.
    
    Parameters:
    
    describeUserRequest -
    
    Returns:
    
    Result of the DescribeUser operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    See Also:
    
    AWS API Documentation
  - describeWorkflow
```
DescribeWorkflowResult describeWorkflow(DescribeWorkflowRequest describeWorkflowRequest)
```
    Describes the specified workflow.
    
    Parameters:
    
    describeWorkflowRequest -
    
    Returns:
    
    Result of the DescribeWorkflow operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    See Also:
    
    AWS API Documentation
  - importSshPublicKey
```
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.
    
    Parameters:
    
    importSshPublicKeyRequest -
    
    Returns:
    
    Result of the ImportSshPublicKey operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    HTTP Status Code: 400
    
    See Also:
    
    AWS API Documentation
  - listAccesses
```
ListAccessesResult listAccesses(ListAccessesRequest listAccessesRequest)
```
    Lists the details for all the accesses you have on your server.
    
    Parameters:
    
    listAccessesRequest -
    
    Returns:
    
    Result of the ListAccesses operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    See Also:
    
    AWS API Documentation
  - listExecutions
```
ListExecutionsResult listExecutions(ListExecutionsRequest listExecutionsRequest)
```
    Lists all executions for the specified workflow.
    
    Parameters:
    
    listExecutionsRequest -
    
    Returns:
    
    Result of the ListExecutions operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    See Also:
    
    AWS API Documentation
  - listSecurityPolicies
```
ListSecurityPoliciesResult listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
```
    Lists the security policies that are attached to your file transfer protocol-enabled servers.
    
    Parameters:
    
    listSecurityPoliciesRequest -
    
    Returns:
    
    Result of the ListSecurityPolicies operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
    
    InvalidNextTokenException - The NextToken parameter that was passed is invalid.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - listServers
```
ListServersResult listServers(ListServersRequest listServersRequest)
```
    Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
    
    Parameters:
    
    listServersRequest -
    
    Returns:
    
    Result of the ListServers operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
    
    InvalidNextTokenException - The NextToken parameter that was passed is invalid.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
    
    InvalidNextTokenException - The NextToken parameter that was passed is invalid.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - listUsers
```
ListUsersResult listUsers(ListUsersRequest listUsersRequest)
```
    Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
    
    Parameters:
    
    listUsersRequest -
    
    Returns:
    
    Result of the ListUsers operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    See Also:
    
    AWS API Documentation
  - listWorkflows
```
ListWorkflowsResult listWorkflows(ListWorkflowsRequest listWorkflowsRequest)
```
    Lists all of your workflows.
    
    Parameters:
    
    listWorkflowsRequest -
    
    Returns:
    
    Result of the ListWorkflows operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
    
    InvalidNextTokenException - The NextToken parameter that was passed is invalid.
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - sendWorkflowStepState
```
SendWorkflowStepStateResult sendWorkflowStepState(SendWorkflowStepStateRequest sendWorkflowStepStateRequest)
```
    Sends a callback for asynchronous custom steps.
    
    The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status.
    
    Parameters:
    
    sendWorkflowStepStateRequest -
    
    Returns:
    
    Result of the SendWorkflowStepState operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    HTTP Status Code: 400
    
    See Also:
    
    AWS API Documentation
  - startServer
```
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.
    
    Parameters:
    
    startServerRequest -
    
    Returns:
    
    Result of the StartServer operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    HTTP Status Code: 400
    
    See Also:
    
    AWS API Documentation
  - stopServer
```
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.
    
    Parameters:
    
    stopServerRequest -
    
    Returns:
    
    Result of the StopServer operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    HTTP Status Code: 400
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
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.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    See Also:
    
    AWS API Documentation
  - testIdentityProvider
```
TestIdentityProviderResult 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. 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
    Parameters:
    
    testIdentityProviderRequest -
    
    Returns:
    
    Result of the TestIdentityProvider operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
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.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    See Also:
    
    AWS API Documentation
  - updateAccess
```
UpdateAccessResult updateAccess(UpdateAccessRequest updateAccessRequest)
```
    Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.
    
    Parameters:
    
    updateAccessRequest -
    
    Returns:
    
    Result of the UpdateAccess operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    See Also:
    
    AWS API Documentation
  - updateServer
```
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.
    
    Parameters:
    
    updateServerRequest -
    
    Returns:
    
    Result of the UpdateServer operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    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.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    HTTP Status Code: 400
    
    See Also:
    
    AWS API Documentation
  - updateUser
```
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.
    
    Parameters:
    
    updateUserRequest -
    
    Returns:
    
    Result of the UpdateUser operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.
    
    InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    HTTP Status Code: 400
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    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.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AWSTransfer

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createAccess

createServer

createUser

createWorkflow

deleteAccess

deleteServer

deleteSshPublicKey

deleteUser

deleteWorkflow

describeAccess

describeExecution

describeSecurityPolicy

describeServer

describeUser

describeWorkflow

importSshPublicKey

listAccesses

listExecutions

listSecurityPolicies

listServers

listTagsForResource

listUsers

listWorkflows

sendWorkflowStepState

startServer

stopServer

tagResource

testIdentityProvider

untagResource

updateAccess

updateServer

updateUser

shutdown

getCachedResponseMetadata