/* * Copyright 2018-2023 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 com.amazonaws.services.transfer; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.transfer.model.*; import com.amazonaws.services.transfer.waiters.AWSTransferWaiters; /** * Interface for accessing AWS Transfer. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.transfer.AbstractAWSTransfer} instead. *
**
* 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) or Amazon EFS. Additionally, you can use Applicability Statement 2 (AS2) to * transfer files into and out of Amazon S3. Amazon Web Services helps you seamlessly migrate your file transfer * workflows to Transfer Family by integrating with existing authentication systems, and providing DNS routing with * Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon * S3, you can use it with Amazon Web Services for processing, analytics, machine learning, and archiving. Getting * started with Transfer Family is easy since there is no infrastructure to buy and set up. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSTransfer { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "transfer"; /** *
* Used by administrators to choose which groups in the directory should have access to upload and download files
* over the enabled protocols using Transfer Family. For example, a Microsoft Active Directory might contain 50,000
* users, but only a small fraction might need the ability to transfer files to the server. An administrator can use
* CreateAccess
to limit the access to the correct set of users who need this ability.
*
* Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer * Family server and an AS2 process. The agreement defines the file and message transfer relationship between the * server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner * profile, certificate, and other attributes. *
*
* The partner is identified with the PartnerProfileId
, and the AS2 process is identified with the
* LocalProfileId
.
*
* Creates the connector, which captures the parameters for an outbound connection for the AS2 or SFTP protocol. The * connector is required for sending files to an externally hosted AS2 or SFTP server. For more details about AS2 * connectors, see Create AS2 connectors. *
*
* You must specify exactly one configuration object: either for AS2 (As2Config
) or SFTP (
* SftpConfig
).
*
* Creates the local or partner profile to use for AS2 transfers. *
* * @param createProfileRequest * @return Result of the CreateProfile operation returned by the service. * @throws ServiceUnavailableException * The request has failed because the Amazon Web ServicesTransfer Family service is not available. * @throws InternalServiceErrorException * This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service. * @throws ThrottlingException * The request was denied due to request throttling. * @sample AWSTransfer.CreateProfile * @see AWS API * Documentation */ CreateProfileResult createProfile(CreateProfileRequest createProfileRequest); /** *
* Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.
* When you make updates to your file transfer protocol-enabled server or when you work with users, use the
* service-generated ServerId
property that is assigned to the newly created server.
*
* 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 Identity and Access Management (IAM) role.
* You can also optionally add a session policy, and assign metadata with tags that can be used to group and search
* for users.
*
* Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer
* completes. After creating a workflow, you can associate the workflow created with any transfer servers by
* specifying the workflow-details
field in CreateServer
and UpdateServer
* operations.
*
* Allows you to delete the access specified in the ServerID
and ExternalID
parameters.
*
* Delete the agreement that's specified in the provided AgreementId
.
*
* Deletes the certificate that's specified in the CertificateId
parameter.
*
* Deletes the connector that's specified in the provided ConnectorId
.
*
* Deletes the host key that's specified in the HostKeyId
parameter.
*
* Deletes the profile that's specified in the ProfileId
parameter.
*
* 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 Amazon Web ServicesTransfer Family service is not available. * @throws InternalServiceErrorException * This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service. * @sample AWSTransfer.DeleteServer * @see AWS API * Documentation */ DeleteServerResult deleteServer(DeleteServerRequest deleteServerRequest); /** ** Deletes a user's Secure Shell (SSH) public key. *
* * @param deleteSshPublicKeyRequest * @return Result of the DeleteSshPublicKey operation returned by the service. * @throws ServiceUnavailableException * The request has failed because the Amazon Web ServicesTransfer Family service is not available. * @throws InternalServiceErrorException * This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service. * @throws ThrottlingException * The request was denied due to request throttling. * @sample AWSTransfer.DeleteSshPublicKey * @see AWS * API Documentation */ DeleteSshPublicKeyResult deleteSshPublicKey(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest); /** ** 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. *
** Deletes the specified workflow. *
* * @param deleteWorkflowRequest * @return Result of the DeleteWorkflow 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 Amazon Web ServicesTransfer Family service is not available. * @throws InternalServiceErrorException * This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service. * @sample AWSTransfer.DeleteWorkflow * @see AWS API * Documentation */ DeleteWorkflowResult deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest); /** *
* Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its
* ServerId
property and its ExternalId
.
*
* The response from this call returns the properties of the access that is associated with the
* ServerId
value that was specified.
*
* Describes the agreement that's identified by the AgreementId
.
*
* Describes the certificate that's identified by the CertificateId
.
*
* Describes the connector that's identified by the ConnectorId.
*
* You can use DescribeExecution
to check the details of the execution of the specified workflow.
*
* This API call only returns details for in-progress workflows. *
*
* If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified
* workflow ID, you receive a ResourceNotFound
exception.
*
* Returns the details of the host key that's specified by the HostKeyId
and ServerId
.
*
* Returns the details of the profile that's specified by the ProfileId
.
*
* 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 Amazon Web ServicesTransfer Family service is not available. * @throws InternalServiceErrorException * This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service. * @sample AWSTransfer.DescribeSecurityPolicy * @see AWS API Documentation */ DescribeSecurityPolicyResult describeSecurityPolicy(DescribeSecurityPolicyRequest describeSecurityPolicyRequest); /** *
* 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
.
*
* 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.
*
* Describes the specified workflow. *
* * @param describeWorkflowRequest * @return Result of the DescribeWorkflow operation returned by the service. * @throws ServiceUnavailableException * The request has failed because the Amazon Web ServicesTransfer Family service is not available. * @throws InternalServiceErrorException * This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service. * @sample AWSTransfer.DescribeWorkflow * @see AWS API * Documentation */ DescribeWorkflowResult describeWorkflow(DescribeWorkflowRequest describeWorkflowRequest); /** ** Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner * profiles. *
* * @param importCertificateRequest * @return Result of the ImportCertificate operation returned by the service. * @throws ServiceUnavailableException * The request has failed because the Amazon Web ServicesTransfer Family service is not available. * @throws InternalServiceErrorException * This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service. * @sample AWSTransfer.ImportCertificate * @see AWS API * Documentation */ ImportCertificateResult importCertificate(ImportCertificateRequest importCertificateRequest); /** *
* Adds a host key to the server that's specified by the ServerId
parameter.
*
* Adds a Secure Shell (SSH) public key to a Transfer Family user 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
.
*
* Lists the details for all the accesses you have on your server. *
* * @param listAccessesRequest * @return Result of the ListAccesses operation returned by the service. * @throws ServiceUnavailableException * The request has failed because the Amazon Web ServicesTransfer Family service is not available. * @throws InternalServiceErrorException * This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service. * @throws InvalidNextTokenException * TheNextToken
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 Amazon Web ServicesTransfer Family service.
* @sample AWSTransfer.ListAccesses
* @see AWS API
* Documentation
*/
ListAccessesResult listAccesses(ListAccessesRequest listAccessesRequest);
/**
*
* Returns a list of the agreements for the server that's identified by the ServerId
that you supply.
* If you want to limit the results to a certain number, supply a value for the MaxResults
parameter.
* If you ran the command previously and received a value for NextToken
, you can supply that value to
* continue listing agreements from where you left off.
*
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 Amazon Web ServicesTransfer Family service.
* @sample AWSTransfer.ListAgreements
* @see AWS API
* Documentation
*/
ListAgreementsResult listAgreements(ListAgreementsRequest listAgreementsRequest);
/**
*
* Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the
* results to a certain number, supply a value for the MaxResults
parameter. If you ran the command
* previously and received a value for the NextToken
parameter, you can supply that value to continue
* listing certificates from where you left off.
*
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 Amazon Web ServicesTransfer Family service.
* @sample AWSTransfer.ListCertificates
* @see AWS API
* Documentation
*/
ListCertificatesResult listCertificates(ListCertificatesRequest listCertificatesRequest);
/**
* * Lists the connectors for the specified Region. *
* * @param listConnectorsRequest * @return Result of the ListConnectors operation returned by the service. * @throws ServiceUnavailableException * The request has failed because the Amazon Web ServicesTransfer Family service is not available. * @throws InternalServiceErrorException * This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service. * @throws InvalidNextTokenException * TheNextToken
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 Amazon Web ServicesTransfer Family service.
* @sample AWSTransfer.ListConnectors
* @see AWS API
* Documentation
*/
ListConnectorsResult listConnectors(ListConnectorsRequest listConnectorsRequest);
/**
* * Lists all in-progress executions for the specified workflow. *
*
* If the specified workflow ID cannot be found, ListExecutions
returns a ResourceNotFound
* exception.
*
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 Amazon Web ServicesTransfer Family service.
* @sample AWSTransfer.ListExecutions
* @see AWS API
* Documentation
*/
ListExecutionsResult listExecutions(ListExecutionsRequest listExecutionsRequest);
/**
*
* Returns a list of host keys for the server that's specified by the ServerId
parameter.
*
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 Amazon Web ServicesTransfer Family service.
* @sample AWSTransfer.ListHostKeys
* @see AWS API
* Documentation
*/
ListHostKeysResult listHostKeys(ListHostKeysRequest listHostKeysRequest);
/**
*
* Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a
* value for the MaxResults
parameter. If you ran the command previously and received a value for
* NextToken
, you can supply that value to continue listing profiles from where you left off.
*
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 Amazon Web ServicesTransfer Family service.
* @sample AWSTransfer.ListProfiles
* @see AWS API
* Documentation
*/
ListProfilesResult listProfiles(ListProfilesRequest listProfilesRequest);
/**
* * 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 Amazon Web ServicesTransfer Family service is not available. * @throws InternalServiceErrorException * This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service. * @throws InvalidNextTokenException * TheNextToken
parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @sample AWSTransfer.ListSecurityPolicies
* @see AWS
* API Documentation
*/
ListSecurityPoliciesResult listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest);
/**
* * Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account. *
* * @param listServersRequest * @return Result of the ListServers operation returned by the service. * @throws ServiceUnavailableException * The request has failed because the Amazon Web ServicesTransfer Family service is not available. * @throws InternalServiceErrorException * This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service. * @throws InvalidNextTokenException * TheNextToken
parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @sample AWSTransfer.ListServers
* @see AWS API
* Documentation
*/
ListServersResult listServers(ListServersRequest listServersRequest);
/**
* * Lists all of the tags associated with the Amazon Resource Name (ARN) that 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 Amazon Web ServicesTransfer Family service is not available. * @throws InternalServiceErrorException * This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service. * @throws InvalidNextTokenException * TheNextToken
parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @sample AWSTransfer.ListTagsForResource
* @see AWS
* API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId
* parameter.
*
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 Amazon Web ServicesTransfer Family service.
* @sample AWSTransfer.ListUsers
* @see AWS API
* Documentation
*/
ListUsersResult listUsers(ListUsersRequest listUsersRequest);
/**
* * Lists all workflows associated with your Amazon Web Services account for your current region. *
* * @param listWorkflowsRequest * @return Result of the ListWorkflows operation returned by the service. * @throws ServiceUnavailableException * The request has failed because the Amazon Web ServicesTransfer Family service is not available. * @throws InternalServiceErrorException * This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service. * @throws InvalidNextTokenException * TheNextToken
parameter that was passed is invalid.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @sample AWSTransfer.ListWorkflows
* @see AWS API
* Documentation
*/
ListWorkflowsResult listWorkflows(ListWorkflowsRequest listWorkflowsRequest);
/**
* * Sends a callback for asynchronous custom steps. *
*
* The ExecutionId
, WorkflowId
, and Token
are passed to the target resource
* during execution of a custom step of a workflow. You must include those with their callback as well as providing
* a status.
*
* Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server. *
*
* For an AS2 connector, you specify the ConnectorId
and one or more SendFilePaths
to
* identify the files you want to transfer.
*
* For an SFTP connector, the file transfer can be either outbound or inbound. In both cases, you specify the
* ConnectorId
. Depending on the direction of the transfer, you also specify the following items:
*
* If you are transferring file from a partner's SFTP server to a Transfer Family server, you specify one or more
* RetreiveFilePaths
to identify the files you want to transfer, and a LocalDirectoryPath
* to specify the destination folder.
*
* If you are transferring file to a partner's SFTP server from Amazon Web Services storage, you specify one or more
* SendFilePaths
to identify the files you want to transfer, and a RemoteDirectoryPath
to
* specify the destination folder.
*
* 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 Amazon Web ServicesTransfer Family service is not available. * @throws InternalServiceErrorException * This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service. * @throws ThrottlingException * The request was denied due to request throttling. * @sample AWSTransfer.StartServer * @see AWS API * Documentation */ StartServerResult startServer(StartServerRequest startServerRequest); /** *
* 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 does 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 Amazon Web ServicesTransfer Family service is not available. * @throws InternalServiceErrorException * This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service. * @throws ThrottlingException * The request was denied due to request throttling. * @sample AWSTransfer.StopServer * @see AWS API * Documentation */ StopServerResult stopServer(StopServerRequest stopServerRequest); /** ** 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 Amazon Web ServicesTransfer Family service is not available. * @throws InternalServiceErrorException * This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service. * @sample AWSTransfer.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** ** Tests whether your SFTP connector is set up successfully. We highly recommend that you call this operation to * test your ability to transfer files between a Transfer Family server and a trading partner's SFTP server. *
* * @param testConnectionRequest * @return Result of the TestConnection operation returned by the service. * @throws ServiceUnavailableException * The request has failed because the Amazon Web ServicesTransfer Family service is not available. * @throws InternalServiceErrorException * This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service. * @sample AWSTransfer.TestConnection * @see AWS API * Documentation */ TestConnectionResult testConnection(TestConnectionRequest testConnectionRequest); /** *
* If the IdentityProviderType
of a file transfer protocol-enabled server is
* AWS_DIRECTORY_SERVICE
or API_Gateway
, tests whether your identity provider is set up
* successfully. We highly recommend that you call this operation to test your authentication method as soon as you
* create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure
* that your users can successfully use the service.
*
* The ServerId
and UserName
parameters are required. The ServerProtocol
,
* SourceIp
, and UserPassword
are all optional.
*
* Note the following: *
*
* You cannot use TestIdentityProvider
if the IdentityProviderType
of your server is
* SERVICE_MANAGED
.
*
* TestIdentityProvider
does not work with keys: it only accepts passwords.
*
* TestIdentityProvider
can test the password operation for a custom Identity Provider that handles
* keys and passwords.
*
* If you provide any incorrect values for any parameters, the Response
field is empty.
*
* If you provide a server ID for a server that uses service-managed users, you get an error: *
*
* An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth
*
* If you enter a Server ID for the --server-id
parameter that does not identify an actual Transfer
* server, you receive the following error:
*
* An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server
* .
*
* It is possible your sever is in a different region. You can specify a region by adding the following:
* --region region-code
, such as --region us-east-2
to specify a server in US East
* (Ohio).
*
* 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 Amazon Web ServicesTransfer Family service is not available. * @throws InternalServiceErrorException * This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service. * @sample AWSTransfer.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** *
* Allows you to update parameters for the access specified in the ServerID
and ExternalID
* parameters.
*
* Updates some of the parameters for an existing agreement. Provide the AgreementId
and the
* ServerId
for the agreement that you want to update, along with the new values for the parameters to
* update.
*
* Updates the active and inactive dates for a certificate. *
* * @param updateCertificateRequest * @return Result of the UpdateCertificate operation returned by the service. * @throws ServiceUnavailableException * The request has failed because the Amazon Web ServicesTransfer Family service is not available. * @throws InternalServiceErrorException * This exception is thrown when an error occurs in the Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service. * @throws ThrottlingException * The request was denied due to request throttling. * @sample AWSTransfer.UpdateCertificate * @see AWS API * Documentation */ UpdateCertificateResult updateCertificate(UpdateCertificateRequest updateCertificateRequest); /** *
* Updates some of the parameters for an existing connector. Provide the ConnectorId
for the connector
* that you want to update, along with the new values for the parameters to update.
*
* Updates the description for the host key that's specified by the ServerId
and HostKeyId
* parameters.
*
* Updates some of the parameters for an existing profile. Provide the ProfileId
for the profile that
* you want to update, along with the new values for the parameters to update.
*
* Updates the file transfer protocol-enabled server's properties after that server has been created. *
*
* The UpdateServer
call returns the ServerId
of the server you updated.
*
UpdateServer
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 Amazon Web ServicesTransfer 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 Amazon Web ServicesTransfer Family service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSTransfer.UpdateServer
* @see AWS API
* Documentation
*/
UpdateServerResult updateServer(UpdateServerRequest updateServerRequest);
/**
*
* 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.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); AWSTransferWaiters waiters(); }