@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSTransfer extends Object implements AWSTransfer
AWSTransfer
. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
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.
|
public CreateServerResult createServer(CreateServerRequest request)
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.
createServer
in interface AWSTransfer
public CreateUserResult createUser(CreateUserRequest request)
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.
createUser
in interface AWSTransfer
public DeleteServerResult deleteServer(DeleteServerRequest request)
AWSTransfer
Deletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.
deleteServer
in interface AWSTransfer
public DeleteSshPublicKeyResult deleteSshPublicKey(DeleteSshPublicKeyRequest request)
AWSTransfer
Deletes a user's Secure Shell (SSH) public key.
No response is returned from this operation.
deleteSshPublicKey
in interface AWSTransfer
public DeleteUserResult deleteUser(DeleteUserRequest request)
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.
deleteUser
in interface AWSTransfer
public DescribeSecurityPolicyResult describeSecurityPolicy(DescribeSecurityPolicyRequest request)
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.
describeSecurityPolicy
in interface AWSTransfer
public DescribeServerResult describeServer(DescribeServerRequest request)
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
.
describeServer
in interface AWSTransfer
public DescribeUserResult describeUser(DescribeUserRequest request)
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.
describeUser
in interface AWSTransfer
public ImportSshPublicKeyResult importSshPublicKey(ImportSshPublicKeyRequest request)
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
.
importSshPublicKey
in interface AWSTransfer
public ListSecurityPoliciesResult listSecurityPolicies(ListSecurityPoliciesRequest request)
AWSTransfer
Lists the security policies that are attached to your file transfer protocol-enabled servers.
listSecurityPolicies
in interface AWSTransfer
public ListServersResult listServers(ListServersRequest request)
AWSTransfer
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
listServers
in interface AWSTransfer
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSTransfer
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
public ListUsersResult listUsers(ListUsersRequest request)
AWSTransfer
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
listUsers
in interface AWSTransfer
public StartServerResult startServer(StartServerRequest request)
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.
startServer
in interface AWSTransfer
public StopServerResult stopServer(StopServerRequest request)
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.
stopServer
in interface AWSTransfer
public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource
in interface AWSTransfer
public TestIdentityProviderResult testIdentityProvider(TestIdentityProviderRequest request)
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.
testIdentityProvider
in interface AWSTransfer
public UntagResourceResult untagResource(UntagResourceRequest request)
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.
untagResource
in interface AWSTransfer
public UpdateServerResult updateServer(UpdateServerRequest request)
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.
updateServer
in interface AWSTransfer
public UpdateUserResult updateUser(UpdateUserRequest request)
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.
updateUser
in interface AWSTransfer
public void shutdown()
AWSTransfer
shutdown
in interface AWSTransfer
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSTransfer
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.
getCachedResponseMetadata
in interface AWSTransfer
request
- The originally executed request.