@Generated(value="software.amazon.awssdk:codegen") public interface TransferClient extends SdkClient
builder() method.
AWS Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3). AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer Family is easy since there is no infrastructure to buy and set up.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static TransferClientBuilder |
builder()
Create a builder that can be used to configure and create a
TransferClient. |
static TransferClient |
create()
Create a
TransferClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateServerResponse |
createServer(Consumer<CreateServerRequest.Builder> createServerRequest)
Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS.
|
default CreateServerResponse |
createServer(CreateServerRequest createServerRequest)
Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS.
|
default CreateUserResponse |
createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user and associates them with an existing file transfer protocol-enabled server.
|
default CreateUserResponse |
createUser(CreateUserRequest createUserRequest)
Creates a user and associates them with an existing file transfer protocol-enabled server.
|
default DeleteServerResponse |
deleteServer(Consumer<DeleteServerRequest.Builder> deleteServerRequest)
Deletes the file transfer protocol-enabled server that you specify.
|
default DeleteServerResponse |
deleteServer(DeleteServerRequest deleteServerRequest)
Deletes the file transfer protocol-enabled server that you specify.
|
default DeleteSshPublicKeyResponse |
deleteSshPublicKey(Consumer<DeleteSshPublicKeyRequest.Builder> deleteSshPublicKeyRequest)
Deletes a user's Secure Shell (SSH) public key.
|
default DeleteSshPublicKeyResponse |
deleteSshPublicKey(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest)
Deletes a user's Secure Shell (SSH) public key.
|
default DeleteUserResponse |
deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes the user belonging to a file transfer protocol-enabled server you specify.
|
default DeleteUserResponse |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the user belonging to a file transfer protocol-enabled server you specify.
|
default DescribeSecurityPolicyResponse |
describeSecurityPolicy(Consumer<DescribeSecurityPolicyRequest.Builder> describeSecurityPolicyRequest)
Describes the security policy that is attached to your file transfer protocol-enabled server.
|
default DescribeSecurityPolicyResponse |
describeSecurityPolicy(DescribeSecurityPolicyRequest describeSecurityPolicyRequest)
Describes the security policy that is attached to your file transfer protocol-enabled server.
|
default DescribeServerResponse |
describeServer(Consumer<DescribeServerRequest.Builder> describeServerRequest)
Describes a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
default DescribeServerResponse |
describeServer(DescribeServerRequest describeServerRequest)
Describes a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
default DescribeUserResponse |
describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property. |
default DescribeUserResponse |
describeUser(DescribeUserRequest describeUserRequest)
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property. |
default ImportSshPublicKeyResponse |
importSshPublicKey(Consumer<ImportSshPublicKeyRequest.Builder> 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. |
default ImportSshPublicKeyResponse |
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. |
default ListSecurityPoliciesResponse |
listSecurityPolicies(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
|
default ListSecurityPoliciesResponse |
listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
|
default ListSecurityPoliciesIterable |
listSecurityPoliciesPaginator(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
|
default ListSecurityPoliciesIterable |
listSecurityPoliciesPaginator(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
|
default ListServersResponse |
listServers()
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
|
default ListServersResponse |
listServers(Consumer<ListServersRequest.Builder> listServersRequest)
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
|
default ListServersResponse |
listServers(ListServersRequest listServersRequest)
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
|
default ListServersIterable |
listServersPaginator()
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
|
default ListServersIterable |
listServersPaginator(Consumer<ListServersRequest.Builder> listServersRequest)
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
|
default ListServersIterable |
listServersPaginator(ListServersRequest listServersRequest)
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify.
|
default ListTagsForResourceIterable |
listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify.
|
default ListTagsForResourceIterable |
listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify.
|
default ListUsersResponse |
listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
default ListUsersResponse |
listUsers(ListUsersRequest listUsersRequest)
Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
default ListUsersIterable |
listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
default ListUsersIterable |
listUsersPaginator(ListUsersRequest listUsersRequest)
Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
static ServiceMetadata |
serviceMetadata() |
default StartServerResponse |
startServer(Consumer<StartServerRequest.Builder> startServerRequest)
Changes the state of a file transfer protocol-enabled server from
OFFLINE to ONLINE. |
default StartServerResponse |
startServer(StartServerRequest startServerRequest)
Changes the state of a file transfer protocol-enabled server from
OFFLINE to ONLINE. |
default StopServerResponse |
stopServer(Consumer<StopServerRequest.Builder> stopServerRequest)
Changes the state of a file transfer protocol-enabled server from
ONLINE to OFFLINE. |
default StopServerResponse |
stopServer(StopServerRequest stopServerRequest)
Changes the state of a file transfer protocol-enabled server from
ONLINE to OFFLINE. |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
|
default TestIdentityProviderResponse |
testIdentityProvider(Consumer<TestIdentityProviderRequest.Builder> testIdentityProviderRequest)
If the
IdentityProviderType of a file transfer protocol-enabled server is API_Gateway,
tests whether your API Gateway is set up successfully. |
default TestIdentityProviderResponse |
testIdentityProvider(TestIdentityProviderRequest testIdentityProviderRequest)
If the
IdentityProviderType of a file transfer protocol-enabled server is API_Gateway,
tests whether your API Gateway is set up successfully. |
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
|
default UpdateServerResponse |
updateServer(Consumer<UpdateServerRequest.Builder> updateServerRequest)
Updates the file transfer protocol-enabled server's properties after that server has been created.
|
default UpdateServerResponse |
updateServer(UpdateServerRequest updateServerRequest)
Updates the file transfer protocol-enabled server's properties after that server has been created.
|
default UpdateUserResponse |
updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
Assigns new properties to a user.
|
default UpdateUserResponse |
updateUser(UpdateUserRequest updateUserRequest)
Assigns new properties to a user.
|
serviceNameclosestatic final String SERVICE_NAME
static TransferClient create()
TransferClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static TransferClientBuilder builder()
TransferClient.default CreateServerResponse createServer(CreateServerRequest createServerRequest) throws AccessDeniedException, ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceExistsException, ThrottlingException, AwsServiceException, SdkClientException, TransferException
Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS. When you make
updates to your file transfer protocol-enabled server or when you work with users, use the service-generated
ServerId property that is assigned to the newly created server.
createServerRequest - AccessDeniedException - You do not have sufficient access to perform this action.ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceExistsException - The requested resource does not exist.ThrottlingException - The request was denied due to request throttling.
HTTP Status Code: 400
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateServerResponse createServer(Consumer<CreateServerRequest.Builder> createServerRequest) throws AccessDeniedException, ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceExistsException, ThrottlingException, AwsServiceException, SdkClientException, TransferException
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.
This is a convenience which creates an instance of the CreateServerRequest.Builder avoiding the need to
create one manually via CreateServerRequest.builder()
createServerRequest - A Consumer that will call methods on CreateServerRequest.Builder to create a request.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
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateUserResponse createUser(CreateUserRequest createUserRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceExistsException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create
and associate users with servers that have the IdentityProviderType set to
SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set
the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM)
role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group
and search for users.
createUserRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceExistsException - The requested resource does not exist.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceExistsException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
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.
This is a convenience which creates an instance of the CreateUserRequest.Builder avoiding the need to
create one manually via CreateUserRequest.builder()
createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteServerResponse deleteServer(DeleteServerRequest deleteServerRequest) throws AccessDeniedException, ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
Deletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.
deleteServerRequest - AccessDeniedException - You do not have sufficient access to perform this action.ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteServerResponse deleteServer(Consumer<DeleteServerRequest.Builder> deleteServerRequest) throws AccessDeniedException, ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
Deletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.
This is a convenience which creates an instance of the DeleteServerRequest.Builder avoiding the need to
create one manually via DeleteServerRequest.builder()
deleteServerRequest - A Consumer that will call methods on DeleteServerRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSshPublicKeyResponse deleteSshPublicKey(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, TransferException
Deletes a user's Secure Shell (SSH) public key.
No response is returned from this operation.
deleteSshPublicKeyRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.ThrottlingException - The request was denied due to request throttling.
HTTP Status Code: 400
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSshPublicKeyResponse deleteSshPublicKey(Consumer<DeleteSshPublicKeyRequest.Builder> deleteSshPublicKeyRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, TransferException
Deletes a user's Secure Shell (SSH) public key.
No response is returned from this operation.
This is a convenience which creates an instance of the DeleteSshPublicKeyRequest.Builder avoiding the
need to create one manually via DeleteSshPublicKeyRequest.builder()
deleteSshPublicKeyRequest - A Consumer that will call methods on DeleteSshPublicKeyRequest.Builder to create a
request.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
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
Deletes the user belonging to a file transfer protocol-enabled server you specify.
No response returns from this operation.
When you delete a user from a server, the user's information is lost.
deleteUserRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
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.
This is a convenience which creates an instance of the DeleteUserRequest.Builder avoiding the need to
create one manually via DeleteUserRequest.builder()
deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSecurityPolicyResponse describeSecurityPolicy(DescribeSecurityPolicyRequest describeSecurityPolicyRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies.
describeSecurityPolicyRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSecurityPolicyResponse describeSecurityPolicy(Consumer<DescribeSecurityPolicyRequest.Builder> describeSecurityPolicyRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
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.
This is a convenience which creates an instance of the DescribeSecurityPolicyRequest.Builder avoiding the
need to create one manually via DescribeSecurityPolicyRequest.builder()
describeSecurityPolicyRequest - A Consumer that will call methods on DescribeSecurityPolicyRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeServerResponse describeServer(DescribeServerRequest describeServerRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
Describes a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
The response contains a description of a server's properties. When you set EndpointType to VPC, the
response will contain the EndpointDetails.
describeServerRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeServerResponse describeServer(Consumer<DescribeServerRequest.Builder> describeServerRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
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.
This is a convenience which creates an instance of the DescribeServerRequest.Builder avoiding the need to
create one manually via DescribeServerRequest.builder()
describeServerRequest - A Consumer that will call methods on DescribeServerRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property.
The response from this call returns the properties of the user associated with the ServerId value
that was specified.
describeUserRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUserResponse describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
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.
This is a convenience which creates an instance of the DescribeUserRequest.Builder avoiding the need to
create one manually via DescribeUserRequest.builder()
describeUserRequest - A Consumer that will call methods on DescribeUserRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ImportSshPublicKeyResponse importSshPublicKey(ImportSshPublicKeyRequest importSshPublicKeyRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, TransferException
Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to
the specific file transfer protocol-enabled server, identified by ServerId.
The response returns the UserName value, the ServerId value, and the name of the
SshPublicKeyId.
importSshPublicKeyRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceExistsException - The requested resource does not exist.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.ThrottlingException - The request was denied due to request throttling.
HTTP Status Code: 400
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ImportSshPublicKeyResponse importSshPublicKey(Consumer<ImportSshPublicKeyRequest.Builder> importSshPublicKeyRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, TransferException
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.
This is a convenience which creates an instance of the ImportSshPublicKeyRequest.Builder avoiding the
need to create one manually via ImportSshPublicKeyRequest.builder()
importSshPublicKeyRequest - A Consumer that will call methods on ImportSshPublicKeyRequest.Builder to create a
request.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
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSecurityPoliciesResponse listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, AwsServiceException, SdkClientException, TransferException
Lists the security policies that are attached to your file transfer protocol-enabled servers.
listSecurityPoliciesRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidNextTokenException - The NextToken parameter that was passed is invalid.InvalidRequestException - This exception is thrown when the client submits a malformed request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSecurityPoliciesResponse listSecurityPolicies(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, AwsServiceException, SdkClientException, TransferException
Lists the security policies that are attached to your file transfer protocol-enabled servers.
This is a convenience which creates an instance of the ListSecurityPoliciesRequest.Builder avoiding the
need to create one manually via ListSecurityPoliciesRequest.builder()
listSecurityPoliciesRequest - A Consumer that will call methods on ListSecurityPoliciesRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSecurityPoliciesIterable listSecurityPoliciesPaginator(ListSecurityPoliciesRequest listSecurityPoliciesRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, AwsServiceException, SdkClientException, TransferException
Lists the security policies that are attached to your file transfer protocol-enabled servers.
This is a variant of
listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesIterable responses = client.listSecurityPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesIterable responses = client
.listSecurityPoliciesPaginator(request);
for (software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesIterable responses = client.listSecurityPoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest)
operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSecurityPoliciesIterable listSecurityPoliciesPaginator(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, AwsServiceException, SdkClientException, TransferException
Lists the security policies that are attached to your file transfer protocol-enabled servers.
This is a variant of
listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesIterable responses = client.listSecurityPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesIterable responses = client
.listSecurityPoliciesPaginator(request);
for (software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesIterable responses = client.listSecurityPoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest)
operation.
This is a convenience which creates an instance of the ListSecurityPoliciesRequest.Builder avoiding the
need to create one manually via ListSecurityPoliciesRequest.builder()
listSecurityPoliciesRequest - A Consumer that will call methods on ListSecurityPoliciesRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListServersResponse listServers() throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, AwsServiceException, SdkClientException, TransferException
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistServers(ListServersRequest),
AWS API
Documentationdefault ListServersResponse listServers(ListServersRequest listServersRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, AwsServiceException, SdkClientException, TransferException
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
listServersRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidNextTokenException - The NextToken parameter that was passed is invalid.InvalidRequestException - This exception is thrown when the client submits a malformed request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListServersResponse listServers(Consumer<ListServersRequest.Builder> listServersRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, AwsServiceException, SdkClientException, TransferException
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
This is a convenience which creates an instance of the ListServersRequest.Builder avoiding the need to
create one manually via ListServersRequest.builder()
listServersRequest - A Consumer that will call methods on ListServersRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListServersIterable listServersPaginator() throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, AwsServiceException, SdkClientException, TransferException
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
This is a variant of listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.transfer.paginators.ListServersIterable responses = client.listServersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.transfer.paginators.ListServersIterable responses = client.listServersPaginator(request);
for (software.amazon.awssdk.services.transfer.model.ListServersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.transfer.paginators.ListServersIterable responses = client.listServersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest) operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistServersPaginator(ListServersRequest),
AWS API
Documentationdefault ListServersIterable listServersPaginator(ListServersRequest listServersRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, AwsServiceException, SdkClientException, TransferException
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
This is a variant of listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.transfer.paginators.ListServersIterable responses = client.listServersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.transfer.paginators.ListServersIterable responses = client.listServersPaginator(request);
for (software.amazon.awssdk.services.transfer.model.ListServersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.transfer.paginators.ListServersIterable responses = client.listServersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest) operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListServersIterable listServersPaginator(Consumer<ListServersRequest.Builder> listServersRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, AwsServiceException, SdkClientException, TransferException
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
This is a variant of listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.transfer.paginators.ListServersIterable responses = client.listServersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.transfer.paginators.ListServersIterable responses = client.listServersPaginator(request);
for (software.amazon.awssdk.services.transfer.model.ListServersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.transfer.paginators.ListServersIterable responses = client.listServersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest) operation.
This is a convenience which creates an instance of the ListServersRequest.Builder avoiding the need to
create one manually via ListServersRequest.builder()
listServersRequest - A Consumer that will call methods on ListServersRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, AwsServiceException, SdkClientException, TransferException
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.
listTagsForResourceRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidNextTokenException - The NextToken parameter that was passed is invalid.InvalidRequestException - This exception is thrown when the client submits a malformed request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, AwsServiceException, SdkClientException, TransferException
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, AwsServiceException, SdkClientException, TransferException
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.transfer.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.transfer.paginators.ListTagsForResourceIterable responses = client
.listTagsForResourcePaginator(request);
for (software.amazon.awssdk.services.transfer.model.ListTagsForResourceResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.transfer.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest)
operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, AwsServiceException, SdkClientException, TransferException
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.transfer.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.transfer.paginators.ListTagsForResourceIterable responses = client
.listTagsForResourcePaginator(request);
for (software.amazon.awssdk.services.transfer.model.ListTagsForResourceResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.transfer.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
listUsersRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidNextTokenException - The NextToken parameter that was passed is invalid.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
This is a variant of listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.transfer.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.transfer.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
for (software.amazon.awssdk.services.transfer.model.ListUsersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.transfer.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest) operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
This is a variant of listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.transfer.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.transfer.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
for (software.amazon.awssdk.services.transfer.model.ListUsersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.transfer.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest) operation.
This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartServerResponse startServer(StartServerRequest startServerRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, TransferException
Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It
has no impact on a server that is already ONLINE. An ONLINE server can accept and
process file transfer jobs.
The state of STARTING indicates that the server is in an intermediate state, either not fully able
to respond, or not fully online. The values of START_FAILED can indicate an error condition.
No response is returned from this call.
startServerRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.ThrottlingException - The request was denied due to request throttling.
HTTP Status Code: 400
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartServerResponse startServer(Consumer<StartServerRequest.Builder> startServerRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, TransferException
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.
This is a convenience which creates an instance of the StartServerRequest.Builder avoiding the need to
create one manually via StartServerRequest.builder()
startServerRequest - A Consumer that will call methods on StartServerRequest.Builder to create a request.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
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopServerResponse stopServer(StopServerRequest stopServerRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, TransferException
Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An
OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such
as server and user properties, are not affected by stopping your server.
Stopping the server will not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.
The state of STOPPING indicates that the server is in an intermediate state, either not fully able
to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.
No response is returned from this call.
stopServerRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.ThrottlingException - The request was denied due to request throttling.
HTTP Status Code: 400
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopServerResponse stopServer(Consumer<StopServerRequest.Builder> stopServerRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, TransferException
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.
This is a convenience which creates an instance of the StopServerRequest.Builder avoiding the need to
create one manually via StopServerRequest.builder()
stopServerRequest - A Consumer that will call methods on StopServerRequest.Builder to create a request.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
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
There is no response returned from this call.
tagResourceRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
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.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TestIdentityProviderResponse testIdentityProvider(TestIdentityProviderRequest testIdentityProviderRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
If the IdentityProviderType of a file transfer protocol-enabled server is API_Gateway,
tests whether your API Gateway is set up successfully. We highly recommend that you call this operation to test
your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the
API Gateway integration to ensure that your users can successfully use the service.
testIdentityProviderRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TestIdentityProviderResponse testIdentityProvider(Consumer<TestIdentityProviderRequest.Builder> testIdentityProviderRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
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.
This is a convenience which creates an instance of the TestIdentityProviderRequest.Builder avoiding the
need to create one manually via TestIdentityProviderRequest.builder()
testIdentityProviderRequest - A Consumer that will call methods on TestIdentityProviderRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
No response is returned from this call.
untagResourceRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException
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.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateServerResponse updateServer(UpdateServerRequest updateServerRequest) throws AccessDeniedException, ServiceUnavailableException, ConflictException, InternalServiceErrorException, InvalidRequestException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, TransferException
Updates the file transfer protocol-enabled server's properties after that server has been created.
The UpdateServer call returns the ServerId of the server you updated.
updateServerRequest - AccessDeniedException - You do not have sufficient access to perform this action.ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.ConflictException - This exception is thrown when the UpdatServer is called for a file transfer protocol-enabled
server that has VPC as the endpoint type and the server's VpcEndpointID is not in the
available state.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceExistsException - The requested resource does not exist.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.ThrottlingException - The request was denied due to request throttling.
HTTP Status Code: 400
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateServerResponse updateServer(Consumer<UpdateServerRequest.Builder> updateServerRequest) throws AccessDeniedException, ServiceUnavailableException, ConflictException, InternalServiceErrorException, InvalidRequestException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, TransferException
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.
This is a convenience which creates an instance of the UpdateServerRequest.Builder avoiding the need to
create one manually via UpdateServerRequest.builder()
updateServerRequest - A Consumer that will call methods on UpdateServerRequest.Builder to create a request.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
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, TransferException
Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory,
role, and policy for the UserName and ServerId you specify.
The response returns the ServerId and the UserName for the updated user.
updateUserRequest - ServiceUnavailableException - The request has failed because the AWS Transfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the AWS Transfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the AWS Transfer Family service.ThrottlingException - The request was denied due to request throttling.
HTTP Status Code: 400
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, TransferException
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.
This is a convenience which creates an instance of the UpdateUserRequest.Builder avoiding the need to
create one manually via UpdateUserRequest.builder()
updateUserRequest - A Consumer that will call methods on UpdateUserRequest.Builder to create a request.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
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.TransferException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2020. All rights reserved.