AbstractAWSTransfer (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.transfer.AbstractAWSTransfer

All Implemented Interfaces:

AWSTransfer

Direct Known Subclasses:

AbstractAWSTransferAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSTransfer
extends Object
implements AWSTransfer
```
Abstract implementation of AWSTransfer. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.transfer.AWSTransfer
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createServer
```
public CreateServerResult createServer(CreateServerRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    createServer in interface AWSTransfer
    
    Returns:
    
    Result of the CreateServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createUser
```
public CreateUserResult createUser(CreateUserRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    createUser in interface AWSTransfer
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteServer
```
public DeleteServerResult deleteServer(DeleteServerRequest request)
```
    Description copied from interface: AWSTransfer
    
    Deletes the file transfer protocol-enabled server that you specify.
    
    No response returns from this operation.
    
    Specified by:
    
    deleteServer in interface AWSTransfer
    
    Returns:
    
    Result of the DeleteServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteSshPublicKey
```
public DeleteSshPublicKeyResult deleteSshPublicKey(DeleteSshPublicKeyRequest request)
```
    Description copied from interface: AWSTransfer
    
    Deletes a user's Secure Shell (SSH) public key.
    
    No response is returned from this operation.
    
    Specified by:
    
    deleteSshPublicKey in interface AWSTransfer
    
    Returns:
    
    Result of the DeleteSshPublicKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
public DeleteUserResult deleteUser(DeleteUserRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    deleteUser in interface AWSTransfer
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeSecurityPolicy
```
public DescribeSecurityPolicyResult describeSecurityPolicy(DescribeSecurityPolicyRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    describeSecurityPolicy in interface AWSTransfer
    
    Returns:
    
    Result of the DescribeSecurityPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeServer
```
public DescribeServerResult describeServer(DescribeServerRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    describeServer in interface AWSTransfer
    
    Returns:
    
    Result of the DescribeServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeUser
```
public DescribeUserResult describeUser(DescribeUserRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    describeUser in interface AWSTransfer
    
    Returns:
    
    Result of the DescribeUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importSshPublicKey
```
public ImportSshPublicKeyResult importSshPublicKey(ImportSshPublicKeyRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    importSshPublicKey in interface AWSTransfer
    
    Returns:
    
    Result of the ImportSshPublicKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSecurityPolicies
```
public ListSecurityPoliciesResult listSecurityPolicies(ListSecurityPoliciesRequest request)
```
    Description copied from interface: AWSTransfer
    
    Lists the security policies that are attached to your file transfer protocol-enabled servers.
    
    Specified by:
    
    listSecurityPolicies in interface AWSTransfer
    
    Returns:
    
    Result of the ListSecurityPolicies operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listServers
```
public ListServersResult listServers(ListServersRequest request)
```
    Description copied from interface: AWSTransfer
    
    Lists the file transfer protocol-enabled servers that are associated with your AWS account.
    
    Specified by:
    
    listServers in interface AWSTransfer
    
    Returns:
    
    Result of the ListServers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSTransfer
    
    Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.
    
    Specified by:
    
    listTagsForResource in interface AWSTransfer
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUsers
```
public ListUsersResult listUsers(ListUsersRequest request)
```
    Description copied from interface: AWSTransfer
    
    Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
    
    Specified by:
    
    listUsers in interface AWSTransfer
    
    Returns:
    
    Result of the ListUsers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startServer
```
public StartServerResult startServer(StartServerRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    startServer in interface AWSTransfer
    
    Returns:
    
    Result of the StartServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopServer
```
public StopServerResult stopServer(StopServerRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    stopServer in interface AWSTransfer
    
    Returns:
    
    Result of the StopServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    tagResource in interface AWSTransfer
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - testIdentityProvider
```
public TestIdentityProviderResult testIdentityProvider(TestIdentityProviderRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    testIdentityProvider in interface AWSTransfer
    
    Returns:
    
    Result of the TestIdentityProvider operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    untagResource in interface AWSTransfer
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateServer
```
public UpdateServerResult updateServer(UpdateServerRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    updateServer in interface AWSTransfer
    
    Returns:
    
    Result of the UpdateServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateUser
```
public UpdateUserResult updateUser(UpdateUserRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    updateUser in interface AWSTransfer
    
    Returns:
    
    Result of the UpdateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    shutdown in interface AWSTransfer
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSTransfer
    
    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?

Class AbstractAWSTransfer

Field Summary

Fields inherited from interface com.amazonaws.services.transfer.AWSTransfer

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createServer

createUser

deleteServer

deleteSshPublicKey

deleteUser

describeSecurityPolicy

describeServer

describeUser

importSshPublicKey

listSecurityPolicies

listServers

listTagsForResource

listUsers

startServer

stopServer

tagResource

testIdentityProvider

untagResource

updateServer

updateUser

shutdown

getCachedResponseMetadata