software.amazon.awssdk.services.transfer.TransferClient Maven / Gradle / Ivy
Show all versions of transfer Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.transfer;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.transfer.model.AccessDeniedException;
import software.amazon.awssdk.services.transfer.model.ConflictException;
import software.amazon.awssdk.services.transfer.model.CreateServerRequest;
import software.amazon.awssdk.services.transfer.model.CreateServerResponse;
import software.amazon.awssdk.services.transfer.model.CreateUserRequest;
import software.amazon.awssdk.services.transfer.model.CreateUserResponse;
import software.amazon.awssdk.services.transfer.model.DeleteServerRequest;
import software.amazon.awssdk.services.transfer.model.DeleteServerResponse;
import software.amazon.awssdk.services.transfer.model.DeleteSshPublicKeyRequest;
import software.amazon.awssdk.services.transfer.model.DeleteSshPublicKeyResponse;
import software.amazon.awssdk.services.transfer.model.DeleteUserRequest;
import software.amazon.awssdk.services.transfer.model.DeleteUserResponse;
import software.amazon.awssdk.services.transfer.model.DescribeSecurityPolicyRequest;
import software.amazon.awssdk.services.transfer.model.DescribeSecurityPolicyResponse;
import software.amazon.awssdk.services.transfer.model.DescribeServerRequest;
import software.amazon.awssdk.services.transfer.model.DescribeServerResponse;
import software.amazon.awssdk.services.transfer.model.DescribeUserRequest;
import software.amazon.awssdk.services.transfer.model.DescribeUserResponse;
import software.amazon.awssdk.services.transfer.model.ImportSshPublicKeyRequest;
import software.amazon.awssdk.services.transfer.model.ImportSshPublicKeyResponse;
import software.amazon.awssdk.services.transfer.model.InternalServiceErrorException;
import software.amazon.awssdk.services.transfer.model.InvalidNextTokenException;
import software.amazon.awssdk.services.transfer.model.InvalidRequestException;
import software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest;
import software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesResponse;
import software.amazon.awssdk.services.transfer.model.ListServersRequest;
import software.amazon.awssdk.services.transfer.model.ListServersResponse;
import software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.transfer.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.transfer.model.ListUsersRequest;
import software.amazon.awssdk.services.transfer.model.ListUsersResponse;
import software.amazon.awssdk.services.transfer.model.ResourceExistsException;
import software.amazon.awssdk.services.transfer.model.ResourceNotFoundException;
import software.amazon.awssdk.services.transfer.model.ServiceUnavailableException;
import software.amazon.awssdk.services.transfer.model.StartServerRequest;
import software.amazon.awssdk.services.transfer.model.StartServerResponse;
import software.amazon.awssdk.services.transfer.model.StopServerRequest;
import software.amazon.awssdk.services.transfer.model.StopServerResponse;
import software.amazon.awssdk.services.transfer.model.TagResourceRequest;
import software.amazon.awssdk.services.transfer.model.TagResourceResponse;
import software.amazon.awssdk.services.transfer.model.TestIdentityProviderRequest;
import software.amazon.awssdk.services.transfer.model.TestIdentityProviderResponse;
import software.amazon.awssdk.services.transfer.model.ThrottlingException;
import software.amazon.awssdk.services.transfer.model.TransferException;
import software.amazon.awssdk.services.transfer.model.UntagResourceRequest;
import software.amazon.awssdk.services.transfer.model.UntagResourceResponse;
import software.amazon.awssdk.services.transfer.model.UpdateServerRequest;
import software.amazon.awssdk.services.transfer.model.UpdateServerResponse;
import software.amazon.awssdk.services.transfer.model.UpdateUserRequest;
import software.amazon.awssdk.services.transfer.model.UpdateUserResponse;
import software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesIterable;
import software.amazon.awssdk.services.transfer.paginators.ListServersIterable;
import software.amazon.awssdk.services.transfer.paginators.ListTagsForResourceIterable;
import software.amazon.awssdk.services.transfer.paginators.ListUsersIterable;
/**
* Service client for accessing AWS Transfer. This can be created using the static {@link #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.
*
*/
@Generated("software.amazon.awssdk:codegen")
public interface TransferClient extends SdkClient {
String SERVICE_NAME = "transfer";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "transfer";
/**
* Create a {@link TransferClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static TransferClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link TransferClient}.
*/
static TransferClientBuilder builder() {
return new DefaultTransferClientBuilder();
}
/**
*
* 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.
*
*
* @param createServerRequest
* @return Result of the CreateServer operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceExistsException
* The requested resource does not exist.
* @throws ThrottlingException
* The request was denied due to request throttling.
*
* HTTP Status Code: 400
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.CreateServer
* @see AWS API
* Documentation
*/
default CreateServerResponse createServer(CreateServerRequest createServerRequest) throws AccessDeniedException,
ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceExistsException,
ThrottlingException, AwsServiceException, SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateServerRequest.Builder} avoiding the need to
* create one manually via {@link CreateServerRequest#builder()}
*
*
* @param createServerRequest
* A {@link Consumer} that will call methods on {@link CreateServerRequest.Builder} to create a request.
* @return Result of the CreateServer operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceExistsException
* The requested resource does not exist.
* @throws ThrottlingException
* The request was denied due to request throttling.
*
* HTTP Status Code: 400
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.CreateServer
* @see AWS API
* Documentation
*/
default CreateServerResponse createServer(Consumer createServerRequest)
throws AccessDeniedException, ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException,
ResourceExistsException, ThrottlingException, AwsServiceException, SdkClientException, TransferException {
return createServer(CreateServerRequest.builder().applyMutation(createServerRequest).build());
}
/**
*
* 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.
*
*
* @param createUserRequest
* @return Result of the CreateUser operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceExistsException
* The requested resource does not exist.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.CreateUser
* @see AWS API
* Documentation
*/
default CreateUserResponse createUser(CreateUserRequest createUserRequest) throws ServiceUnavailableException,
InternalServiceErrorException, InvalidRequestException, ResourceExistsException, ResourceNotFoundException,
AwsServiceException, SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateUserRequest.Builder} avoiding the need to
* create one manually via {@link CreateUserRequest#builder()}
*
*
* @param createUserRequest
* A {@link Consumer} that will call methods on {@link CreateUserRequest.Builder} to create a request.
* @return Result of the CreateUser operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceExistsException
* The requested resource does not exist.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.CreateUser
* @see AWS API
* Documentation
*/
default CreateUserResponse createUser(Consumer createUserRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceExistsException,
ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException {
return createUser(CreateUserRequest.builder().applyMutation(createUserRequest).build());
}
/**
*
* Deletes the file transfer protocol-enabled server that you specify.
*
*
* No response returns from this operation.
*
*
* @param deleteServerRequest
* @return Result of the DeleteServer operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.DeleteServer
* @see AWS API
* Documentation
*/
default DeleteServerResponse deleteServer(DeleteServerRequest deleteServerRequest) throws AccessDeniedException,
ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException,
AwsServiceException, SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteServerRequest.Builder} avoiding the need to
* create one manually via {@link DeleteServerRequest#builder()}
*
*
* @param deleteServerRequest
* A {@link Consumer} that will call methods on {@link DeleteServerRequest.Builder} to create a request.
* @return Result of the DeleteServer operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.DeleteServer
* @see AWS API
* Documentation
*/
default DeleteServerResponse deleteServer(Consumer deleteServerRequest)
throws AccessDeniedException, ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException,
ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException {
return deleteServer(DeleteServerRequest.builder().applyMutation(deleteServerRequest).build());
}
/**
*
* Deletes a user's Secure Shell (SSH) public key.
*
*
* No response is returned from this operation.
*
*
* @param deleteSshPublicKeyRequest
* @return Result of the DeleteSshPublicKey operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws ThrottlingException
* The request was denied due to request throttling.
*
* HTTP Status Code: 400
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.DeleteSshPublicKey
* @see AWS
* API Documentation
*/
default DeleteSshPublicKeyResponse deleteSshPublicKey(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException,
ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteSshPublicKeyRequest.Builder} avoiding the
* need to create one manually via {@link DeleteSshPublicKeyRequest#builder()}
*
*
* @param deleteSshPublicKeyRequest
* A {@link Consumer} that will call methods on {@link DeleteSshPublicKeyRequest.Builder} to create a
* request.
* @return Result of the DeleteSshPublicKey operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws ThrottlingException
* The request was denied due to request throttling.
*
* HTTP Status Code: 400
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.DeleteSshPublicKey
* @see AWS
* API Documentation
*/
default DeleteSshPublicKeyResponse deleteSshPublicKey(Consumer deleteSshPublicKeyRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException,
ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, TransferException {
return deleteSshPublicKey(DeleteSshPublicKeyRequest.builder().applyMutation(deleteSshPublicKeyRequest).build());
}
/**
*
* 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.
*
*
*
* @param deleteUserRequest
* @return Result of the DeleteUser operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.DeleteUser
* @see AWS API
* Documentation
*/
default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws ServiceUnavailableException,
InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException,
SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteUserRequest.Builder} avoiding the need to
* create one manually via {@link DeleteUserRequest#builder()}
*
*
* @param deleteUserRequest
* A {@link Consumer} that will call methods on {@link DeleteUserRequest.Builder} to create a request.
* @return Result of the DeleteUser operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.DeleteUser
* @see AWS API
* Documentation
*/
default DeleteUserResponse deleteUser(Consumer deleteUserRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException,
ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException {
return deleteUser(DeleteUserRequest.builder().applyMutation(deleteUserRequest).build());
}
/**
*
* 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.
*
*
* @param describeSecurityPolicyRequest
* @return Result of the DescribeSecurityPolicy operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.DescribeSecurityPolicy
* @see AWS API Documentation
*/
default DescribeSecurityPolicyResponse describeSecurityPolicy(DescribeSecurityPolicyRequest describeSecurityPolicyRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException,
ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeSecurityPolicyRequest.Builder} avoiding the
* need to create one manually via {@link DescribeSecurityPolicyRequest#builder()}
*
*
* @param describeSecurityPolicyRequest
* A {@link Consumer} that will call methods on {@link DescribeSecurityPolicyRequest.Builder} to create a
* request.
* @return Result of the DescribeSecurityPolicy operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.DescribeSecurityPolicy
* @see AWS API Documentation
*/
default DescribeSecurityPolicyResponse describeSecurityPolicy(
Consumer describeSecurityPolicyRequest) throws ServiceUnavailableException,
InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException,
SdkClientException, TransferException {
return describeSecurityPolicy(DescribeSecurityPolicyRequest.builder().applyMutation(describeSecurityPolicyRequest)
.build());
}
/**
*
* 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.
*
*
* @param describeServerRequest
* @return Result of the DescribeServer operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.DescribeServer
* @see AWS API
* Documentation
*/
default DescribeServerResponse describeServer(DescribeServerRequest describeServerRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException,
ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeServerRequest.Builder} avoiding the need to
* create one manually via {@link DescribeServerRequest#builder()}
*
*
* @param describeServerRequest
* A {@link Consumer} that will call methods on {@link DescribeServerRequest.Builder} to create a request.
* @return Result of the DescribeServer operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.DescribeServer
* @see AWS API
* Documentation
*/
default DescribeServerResponse describeServer(Consumer describeServerRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException,
ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException {
return describeServer(DescribeServerRequest.builder().applyMutation(describeServerRequest).build());
}
/**
*
* 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.
*
*
* @param describeUserRequest
* @return Result of the DescribeUser operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.DescribeUser
* @see AWS API
* Documentation
*/
default DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest) throws ServiceUnavailableException,
InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException,
SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeUserRequest.Builder} avoiding the need to
* create one manually via {@link DescribeUserRequest#builder()}
*
*
* @param describeUserRequest
* A {@link Consumer} that will call methods on {@link DescribeUserRequest.Builder} to create a request.
* @return Result of the DescribeUser operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.DescribeUser
* @see AWS API
* Documentation
*/
default DescribeUserResponse describeUser(Consumer describeUserRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException,
ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException {
return describeUser(DescribeUserRequest.builder().applyMutation(describeUserRequest).build());
}
/**
*
* 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.
*
*
* @param importSshPublicKeyRequest
* @return Result of the ImportSshPublicKey operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceExistsException
* The requested resource does not exist.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws ThrottlingException
* The request was denied due to request throttling.
*
* HTTP Status Code: 400
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.ImportSshPublicKey
* @see AWS
* API Documentation
*/
default ImportSshPublicKeyResponse importSshPublicKey(ImportSshPublicKeyRequest importSshPublicKeyRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceExistsException,
ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ImportSshPublicKeyRequest.Builder} avoiding the
* need to create one manually via {@link ImportSshPublicKeyRequest#builder()}
*
*
* @param importSshPublicKeyRequest
* A {@link Consumer} that will call methods on {@link ImportSshPublicKeyRequest.Builder} to create a
* request.
* @return Result of the ImportSshPublicKey operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceExistsException
* The requested resource does not exist.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws ThrottlingException
* The request was denied due to request throttling.
*
* HTTP Status Code: 400
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.ImportSshPublicKey
* @see AWS
* API Documentation
*/
default ImportSshPublicKeyResponse importSshPublicKey(Consumer importSshPublicKeyRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException, ResourceExistsException,
ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, TransferException {
return importSshPublicKey(ImportSshPublicKeyRequest.builder().applyMutation(importSshPublicKeyRequest).build());
}
/**
*
* Lists the security policies that are attached to your file transfer protocol-enabled servers.
*
*
* @param listSecurityPoliciesRequest
* @return Result of the ListSecurityPolicies operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidNextTokenException
* The NextToken parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.ListSecurityPolicies
* @see AWS
* API Documentation
*/
default ListSecurityPoliciesResponse listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException,
InvalidRequestException, AwsServiceException, SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* Lists the security policies that are attached to your file transfer protocol-enabled servers.
*
*
*
* This is a convenience which creates an instance of the {@link ListSecurityPoliciesRequest.Builder} avoiding the
* need to create one manually via {@link ListSecurityPoliciesRequest#builder()}
*
*
* @param listSecurityPoliciesRequest
* A {@link Consumer} that will call methods on {@link ListSecurityPoliciesRequest.Builder} to create a
* request.
* @return Result of the ListSecurityPolicies operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidNextTokenException
* The NextToken parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.ListSecurityPolicies
* @see AWS
* API Documentation
*/
default ListSecurityPoliciesResponse listSecurityPolicies(
Consumer listSecurityPoliciesRequest) throws ServiceUnavailableException,
InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, AwsServiceException,
SdkClientException, TransferException {
return listSecurityPolicies(ListSecurityPoliciesRequest.builder().applyMutation(listSecurityPoliciesRequest).build());
}
/**
*
* Lists the security policies that are attached to your file transfer protocol-enabled servers.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest)}
* operation.
*
*
* @param listSecurityPoliciesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidNextTokenException
* The NextToken parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.ListSecurityPolicies
* @see AWS
* API Documentation
*/
default ListSecurityPoliciesIterable listSecurityPoliciesPaginator(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException,
InvalidRequestException, AwsServiceException, SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* Lists the security policies that are attached to your file transfer protocol-enabled servers.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListSecurityPoliciesRequest.Builder} avoiding the
* need to create one manually via {@link ListSecurityPoliciesRequest#builder()}
*
*
* @param listSecurityPoliciesRequest
* A {@link Consumer} that will call methods on {@link ListSecurityPoliciesRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidNextTokenException
* The NextToken parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.ListSecurityPolicies
* @see AWS
* API Documentation
*/
default ListSecurityPoliciesIterable listSecurityPoliciesPaginator(
Consumer listSecurityPoliciesRequest) throws ServiceUnavailableException,
InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, AwsServiceException,
SdkClientException, TransferException {
return listSecurityPoliciesPaginator(ListSecurityPoliciesRequest.builder().applyMutation(listSecurityPoliciesRequest)
.build());
}
/**
*
* Lists the file transfer protocol-enabled servers that are associated with your AWS account.
*
*
* @return Result of the ListServers operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidNextTokenException
* The NextToken parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.ListServers
* @see #listServers(ListServersRequest)
* @see AWS API
* Documentation
*/
default ListServersResponse listServers() throws ServiceUnavailableException, InternalServiceErrorException,
InvalidNextTokenException, InvalidRequestException, AwsServiceException, SdkClientException, TransferException {
return listServers(ListServersRequest.builder().build());
}
/**
*
* Lists the file transfer protocol-enabled servers that are associated with your AWS account.
*
*
* @param listServersRequest
* @return Result of the ListServers operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidNextTokenException
* The NextToken parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.ListServers
* @see AWS API
* Documentation
*/
default ListServersResponse listServers(ListServersRequest listServersRequest) throws ServiceUnavailableException,
InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, AwsServiceException,
SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* Lists the file transfer protocol-enabled servers that are associated with your AWS account.
*
*
*
* This is a convenience which creates an instance of the {@link ListServersRequest.Builder} avoiding the need to
* create one manually via {@link ListServersRequest#builder()}
*
*
* @param listServersRequest
* A {@link Consumer} that will call methods on {@link ListServersRequest.Builder} to create a request.
* @return Result of the ListServers operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidNextTokenException
* The NextToken parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.ListServers
* @see AWS API
* Documentation
*/
default ListServersResponse listServers(Consumer listServersRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException,
InvalidRequestException, AwsServiceException, SdkClientException, TransferException {
return listServers(ListServersRequest.builder().applyMutation(listServersRequest).build());
}
/**
*
* Lists the file transfer protocol-enabled servers that are associated with your AWS account.
*
*
*
* This is a variant of {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest)} operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidNextTokenException
* The NextToken parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.ListServers
* @see #listServersPaginator(ListServersRequest)
* @see AWS API
* Documentation
*/
default ListServersIterable listServersPaginator() throws ServiceUnavailableException, InternalServiceErrorException,
InvalidNextTokenException, InvalidRequestException, AwsServiceException, SdkClientException, TransferException {
return listServersPaginator(ListServersRequest.builder().build());
}
/**
*
* Lists the file transfer protocol-enabled servers that are associated with your AWS account.
*
*
*
* This is a variant of {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest)} operation.
*
*
* @param listServersRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidNextTokenException
* The NextToken parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.ListServers
* @see AWS API
* Documentation
*/
default ListServersIterable listServersPaginator(ListServersRequest listServersRequest) throws ServiceUnavailableException,
InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, AwsServiceException,
SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* Lists the file transfer protocol-enabled servers that are associated with your AWS account.
*
*
*
* This is a variant of {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListServersRequest.Builder} avoiding the need to
* create one manually via {@link ListServersRequest#builder()}
*
*
* @param listServersRequest
* A {@link Consumer} that will call methods on {@link ListServersRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidNextTokenException
* The NextToken parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.ListServers
* @see AWS API
* Documentation
*/
default ListServersIterable listServersPaginator(Consumer listServersRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException,
InvalidRequestException, AwsServiceException, SdkClientException, TransferException {
return listServersPaginator(ListServersRequest.builder().applyMutation(listServersRequest).build());
}
/**
*
* Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user,
* server, or role.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidNextTokenException
* The NextToken parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException,
InvalidRequestException, AwsServiceException, SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on {@link ListTagsForResourceRequest.Builder} to create a
* request.
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidNextTokenException
* The NextToken parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(
Consumer listTagsForResourceRequest) throws ServiceUnavailableException,
InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, AwsServiceException,
SdkClientException, TransferException {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest)}
* operation.
*
*
* @param listTagsForResourceRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidNextTokenException
* The NextToken parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException,
InvalidRequestException, AwsServiceException, SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on {@link ListTagsForResourceRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidNextTokenException
* The NextToken parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default ListTagsForResourceIterable listTagsForResourcePaginator(
Consumer listTagsForResourceRequest) throws ServiceUnavailableException,
InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, AwsServiceException,
SdkClientException, TransferException {
return listTagsForResourcePaginator(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest)
.build());
}
/**
*
* Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId
* parameter.
*
*
* @param listUsersRequest
* @return Result of the ListUsers operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidNextTokenException
* The NextToken parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.ListUsers
* @see AWS API
* Documentation
*/
default ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws ServiceUnavailableException,
InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, ResourceNotFoundException,
AwsServiceException, SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListUsersRequest.Builder} avoiding the need to
* create one manually via {@link ListUsersRequest#builder()}
*
*
* @param listUsersRequest
* A {@link Consumer} that will call methods on {@link ListUsersRequest.Builder} to create a request.
* @return Result of the ListUsers operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidNextTokenException
* The NextToken parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.ListUsers
* @see AWS API
* Documentation
*/
default ListUsersResponse listUsers(Consumer listUsersRequest) throws ServiceUnavailableException,
InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, ResourceNotFoundException,
AwsServiceException, SdkClientException, TransferException {
return listUsers(ListUsersRequest.builder().applyMutation(listUsersRequest).build());
}
/**
*
* Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId
* parameter.
*
*
*
* This is a variant of {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest)} operation.
*
*
* @param listUsersRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidNextTokenException
* The NextToken parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.ListUsers
* @see AWS API
* Documentation
*/
default ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest) throws ServiceUnavailableException,
InternalServiceErrorException, InvalidNextTokenException, InvalidRequestException, ResourceNotFoundException,
AwsServiceException, SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId
* parameter.
*
*
*
* This is a variant of {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListUsersRequest.Builder} avoiding the need to
* create one manually via {@link ListUsersRequest#builder()}
*
*
* @param listUsersRequest
* A {@link Consumer} that will call methods on {@link ListUsersRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidNextTokenException
* The NextToken parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.ListUsers
* @see AWS API
* Documentation
*/
default ListUsersIterable listUsersPaginator(Consumer listUsersRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidNextTokenException,
InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException {
return listUsersPaginator(ListUsersRequest.builder().applyMutation(listUsersRequest).build());
}
/**
*
* 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.
*
*
* @param startServerRequest
* @return Result of the StartServer operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws ThrottlingException
* The request was denied due to request throttling.
*
* HTTP Status Code: 400
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.StartServer
* @see AWS API
* Documentation
*/
default StartServerResponse startServer(StartServerRequest startServerRequest) throws ServiceUnavailableException,
InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, ThrottlingException,
AwsServiceException, SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StartServerRequest.Builder} avoiding the need to
* create one manually via {@link StartServerRequest#builder()}
*
*
* @param startServerRequest
* A {@link Consumer} that will call methods on {@link StartServerRequest.Builder} to create a request.
* @return Result of the StartServer operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws ThrottlingException
* The request was denied due to request throttling.
*
* HTTP Status Code: 400
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.StartServer
* @see AWS API
* Documentation
*/
default StartServerResponse startServer(Consumer startServerRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException,
ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, TransferException {
return startServer(StartServerRequest.builder().applyMutation(startServerRequest).build());
}
/**
*
* 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.
*
*
* @param stopServerRequest
* @return Result of the StopServer operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws ThrottlingException
* The request was denied due to request throttling.
*
* HTTP Status Code: 400
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.StopServer
* @see AWS API
* Documentation
*/
default StopServerResponse stopServer(StopServerRequest stopServerRequest) throws ServiceUnavailableException,
InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, ThrottlingException,
AwsServiceException, SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StopServerRequest.Builder} avoiding the need to
* create one manually via {@link StopServerRequest#builder()}
*
*
* @param stopServerRequest
* A {@link Consumer} that will call methods on {@link StopServerRequest.Builder} to create a request.
* @return Result of the StopServer operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws ThrottlingException
* The request was denied due to request throttling.
*
* HTTP Status Code: 400
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.StopServer
* @see AWS API
* Documentation
*/
default StopServerResponse stopServer(Consumer stopServerRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException,
ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, TransferException {
return stopServer(StopServerRequest.builder().applyMutation(stopServerRequest).build());
}
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ServiceUnavailableException,
InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException,
SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on {@link TagResourceRequest.Builder} to create a request.
* @return Result of the TagResource operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(Consumer tagResourceRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException,
ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* 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.
*
*
* @param testIdentityProviderRequest
* @return Result of the TestIdentityProvider operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.TestIdentityProvider
* @see AWS
* API Documentation
*/
default TestIdentityProviderResponse testIdentityProvider(TestIdentityProviderRequest testIdentityProviderRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException,
ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link TestIdentityProviderRequest.Builder} avoiding the
* need to create one manually via {@link TestIdentityProviderRequest#builder()}
*
*
* @param testIdentityProviderRequest
* A {@link Consumer} that will call methods on {@link TestIdentityProviderRequest.Builder} to create a
* request.
* @return Result of the TestIdentityProvider operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.TestIdentityProvider
* @see AWS
* API Documentation
*/
default TestIdentityProviderResponse testIdentityProvider(
Consumer testIdentityProviderRequest) throws ServiceUnavailableException,
InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException,
SdkClientException, TransferException {
return testIdentityProvider(TestIdentityProviderRequest.builder().applyMutation(testIdentityProviderRequest).build());
}
/**
*
* 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.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ServiceUnavailableException,
InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, AwsServiceException,
SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on {@link UntagResourceRequest.Builder} to create a request.
* @return Result of the UntagResource operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(Consumer untagResourceRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException,
ResourceNotFoundException, AwsServiceException, SdkClientException, TransferException {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* 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.
*
*
* @param updateServerRequest
* @return Result of the UpdateServer operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws 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.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceExistsException
* The requested resource does not exist.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws ThrottlingException
* The request was denied due to request throttling.
*
* HTTP Status Code: 400
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.UpdateServer
* @see AWS API
* Documentation
*/
default UpdateServerResponse updateServer(UpdateServerRequest updateServerRequest) throws AccessDeniedException,
ServiceUnavailableException, ConflictException, InternalServiceErrorException, InvalidRequestException,
ResourceExistsException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException,
TransferException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UpdateServerRequest.Builder} avoiding the need to
* create one manually via {@link UpdateServerRequest#builder()}
*
*
* @param updateServerRequest
* A {@link Consumer} that will call methods on {@link UpdateServerRequest.Builder} to create a request.
* @return Result of the UpdateServer operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws 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.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceExistsException
* The requested resource does not exist.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws ThrottlingException
* The request was denied due to request throttling.
*
* HTTP Status Code: 400
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.UpdateServer
* @see AWS API
* Documentation
*/
default UpdateServerResponse updateServer(Consumer updateServerRequest)
throws AccessDeniedException, ServiceUnavailableException, ConflictException, InternalServiceErrorException,
InvalidRequestException, ResourceExistsException, ResourceNotFoundException, ThrottlingException,
AwsServiceException, SdkClientException, TransferException {
return updateServer(UpdateServerRequest.builder().applyMutation(updateServerRequest).build());
}
/**
*
* 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.
*
*
* @param updateUserRequest
* @return Result of the UpdateUser operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws ThrottlingException
* The request was denied due to request throttling.
*
* HTTP Status Code: 400
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.UpdateUser
* @see AWS API
* Documentation
*/
default UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws ServiceUnavailableException,
InternalServiceErrorException, InvalidRequestException, ResourceNotFoundException, ThrottlingException,
AwsServiceException, SdkClientException, TransferException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UpdateUserRequest.Builder} avoiding the need to
* create one manually via {@link UpdateUserRequest#builder()}
*
*
* @param updateUserRequest
* A {@link Consumer} that will call methods on {@link UpdateUserRequest.Builder} to create a request.
* @return Result of the UpdateUser operation returned by the service.
* @throws ServiceUnavailableException
* The request has failed because the AWS Transfer Family service is not available.
* @throws InternalServiceErrorException
* This exception is thrown when an error occurs in the AWS Transfer Family service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws ResourceNotFoundException
* This exception is thrown when a resource is not found by the AWS Transfer Family service.
* @throws ThrottlingException
* The request was denied due to request throttling.
*
* HTTP Status Code: 400
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws TransferException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample TransferClient.UpdateUser
* @see AWS API
* Documentation
*/
default UpdateUserResponse updateUser(Consumer updateUserRequest)
throws ServiceUnavailableException, InternalServiceErrorException, InvalidRequestException,
ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, TransferException {
return updateUser(UpdateUserRequest.builder().applyMutation(updateUserRequest).build());
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of(SERVICE_METADATA_ID);
}
}