@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSTransfer
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CreateAccessResult |
createAccess(CreateAccessRequest createAccessRequest)
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.
|
CreateAgreementResult |
createAgreement(CreateAgreementRequest createAgreementRequest)
Creates an agreement.
|
CreateConnectorResult |
createConnector(CreateConnectorRequest createConnectorRequest)
Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.
|
CreateProfileResult |
createProfile(CreateProfileRequest createProfileRequest)
Creates the local or partner profile to use for AS2 transfers.
|
CreateServerResult |
createServer(CreateServerRequest createServerRequest)
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.
|
CreateUserResult |
createUser(CreateUserRequest createUserRequest)
Creates a user and associates them with an existing file transfer protocol-enabled server.
|
CreateWorkflowResult |
createWorkflow(CreateWorkflowRequest createWorkflowRequest)
Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer
completes.
|
DeleteAccessResult |
deleteAccess(DeleteAccessRequest deleteAccessRequest)
Allows you to delete the access specified in the
ServerID and ExternalID parameters. |
DeleteAgreementResult |
deleteAgreement(DeleteAgreementRequest deleteAgreementRequest)
Delete the agreement that's specified in the provided
AgreementId. |
DeleteCertificateResult |
deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
Deletes the certificate that's specified in the
CertificateId parameter. |
DeleteConnectorResult |
deleteConnector(DeleteConnectorRequest deleteConnectorRequest)
Deletes the connector that's specified in the provided
ConnectorId. |
DeleteHostKeyResult |
deleteHostKey(DeleteHostKeyRequest deleteHostKeyRequest)
Deletes the host key that's specified in the
HostKeyId parameter. |
DeleteProfileResult |
deleteProfile(DeleteProfileRequest deleteProfileRequest)
Deletes the profile that's specified in the
ProfileId parameter. |
DeleteServerResult |
deleteServer(DeleteServerRequest deleteServerRequest)
Deletes the file transfer protocol-enabled server that you specify.
|
DeleteSshPublicKeyResult |
deleteSshPublicKey(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest)
Deletes a user's Secure Shell (SSH) public key.
|
DeleteUserResult |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the user belonging to a file transfer protocol-enabled server you specify.
|
DeleteWorkflowResult |
deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest)
Deletes the specified workflow.
|
DescribeAccessResult |
describeAccess(DescribeAccessRequest describeAccessRequest)
Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property and its ExternalId. |
DescribeAgreementResult |
describeAgreement(DescribeAgreementRequest describeAgreementRequest)
Describes the agreement that's identified by the
AgreementId. |
DescribeCertificateResult |
describeCertificate(DescribeCertificateRequest describeCertificateRequest)
Describes the certificate that's identified by the
CertificateId. |
DescribeConnectorResult |
describeConnector(DescribeConnectorRequest describeConnectorRequest)
Describes the connector that's identified by the
ConnectorId. |
DescribeExecutionResult |
describeExecution(DescribeExecutionRequest describeExecutionRequest)
You can use
DescribeExecution to check the details of the execution of the specified workflow. |
DescribeHostKeyResult |
describeHostKey(DescribeHostKeyRequest describeHostKeyRequest)
Returns the details of the host key that's specified by the
HostKeyId and ServerId. |
DescribeProfileResult |
describeProfile(DescribeProfileRequest describeProfileRequest)
Returns the details of the profile that's specified by the
ProfileId. |
DescribeSecurityPolicyResult |
describeSecurityPolicy(DescribeSecurityPolicyRequest describeSecurityPolicyRequest)
Describes the security policy that is attached to your server or SFTP connector.
|
DescribeServerResult |
describeServer(DescribeServerRequest describeServerRequest)
Describes a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
DescribeUserResult |
describeUser(DescribeUserRequest describeUserRequest)
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property. |
DescribeWorkflowResult |
describeWorkflow(DescribeWorkflowRequest describeWorkflowRequest)
Describes the specified workflow.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ImportCertificateResult |
importCertificate(ImportCertificateRequest importCertificateRequest)
Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner
profiles.
|
ImportHostKeyResult |
importHostKey(ImportHostKeyRequest importHostKeyRequest)
Adds a host key to the server that's specified by the
ServerId parameter. |
ImportSshPublicKeyResult |
importSshPublicKey(ImportSshPublicKeyRequest importSshPublicKeyRequest)
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. |
ListAccessesResult |
listAccesses(ListAccessesRequest listAccessesRequest)
Lists the details for all the accesses you have on your server.
|
ListAgreementsResult |
listAgreements(ListAgreementsRequest listAgreementsRequest)
Returns a list of the agreements for the server that's identified by the
ServerId that you supply. |
ListCertificatesResult |
listCertificates(ListCertificatesRequest listCertificatesRequest)
Returns a list of the current certificates that have been imported into Transfer Family.
|
ListConnectorsResult |
listConnectors(ListConnectorsRequest listConnectorsRequest)
Lists the connectors for the specified Region.
|
ListExecutionsResult |
listExecutions(ListExecutionsRequest listExecutionsRequest)
Lists all in-progress executions for the specified workflow.
|
ListHostKeysResult |
listHostKeys(ListHostKeysRequest listHostKeysRequest)
Returns a list of host keys for the server that's specified by the
ServerId parameter. |
ListProfilesResult |
listProfiles(ListProfilesRequest listProfilesRequest)
Returns a list of the profiles for your system.
|
ListSecurityPoliciesResult |
listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
Lists the security policies that are attached to your servers and SFTP connectors.
|
ListServersResult |
listServers(ListServersRequest listServersRequest)
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
|
ListUsersResult |
listUsers(ListUsersRequest listUsersRequest)
Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
ListWorkflowsResult |
listWorkflows(ListWorkflowsRequest listWorkflowsRequest)
Lists all workflows associated with your Amazon Web Services account for your current region.
|
SendWorkflowStepStateResult |
sendWorkflowStepState(SendWorkflowStepStateRequest sendWorkflowStepStateRequest)
Sends a callback for asynchronous custom steps.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartDirectoryListingResult |
startDirectoryListing(StartDirectoryListingRequest startDirectoryListingRequest)
Retrieves a list of the contents of a directory from a remote SFTP server.
|
StartFileTransferResult |
startFileTransfer(StartFileTransferRequest startFileTransferRequest)
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
|
StartServerResult |
startServer(StartServerRequest startServerRequest)
Changes the state of a file transfer protocol-enabled server from
OFFLINE to ONLINE. |
StopServerResult |
stopServer(StopServerRequest stopServerRequest)
Changes the state of a file transfer protocol-enabled server from
ONLINE to OFFLINE. |
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
|
TestConnectionResult |
testConnection(TestConnectionRequest testConnectionRequest)
Tests whether your SFTP connector is set up successfully.
|
TestIdentityProviderResult |
testIdentityProvider(TestIdentityProviderRequest testIdentityProviderRequest)
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. |
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
|
UpdateAccessResult |
updateAccess(UpdateAccessRequest updateAccessRequest)
Allows you to update parameters for the access specified in the
ServerID and ExternalID
parameters. |
UpdateAgreementResult |
updateAgreement(UpdateAgreementRequest updateAgreementRequest)
Updates some of the parameters for an existing agreement.
|
UpdateCertificateResult |
updateCertificate(UpdateCertificateRequest updateCertificateRequest)
Updates the active and inactive dates for a certificate.
|
UpdateConnectorResult |
updateConnector(UpdateConnectorRequest updateConnectorRequest)
Updates some of the parameters for an existing connector.
|
UpdateHostKeyResult |
updateHostKey(UpdateHostKeyRequest updateHostKeyRequest)
Updates the description for the host key that's specified by the
ServerId and HostKeyId
parameters. |
UpdateProfileResult |
updateProfile(UpdateProfileRequest updateProfileRequest)
Updates some of the parameters for an existing profile.
|
UpdateServerResult |
updateServer(UpdateServerRequest updateServerRequest)
Updates the file transfer protocol-enabled server's properties after that server has been created.
|
UpdateUserResult |
updateUser(UpdateUserRequest updateUserRequest)
Assigns new properties to a user.
|
AWSTransferWaiters |
waiters() |
static final String ENDPOINT_PREFIX
CreateAccessResult createAccess(CreateAccessRequest createAccessRequest)
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.
createAccessRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.ResourceExistsException - The requested resource does not exist, or exists in a region other than the one specified for the
command.CreateAgreementResult createAgreement(CreateAgreementRequest createAgreementRequest)
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.
createAgreementRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.ResourceExistsException - The requested resource does not exist, or exists in a region other than the one specified for the
command.CreateConnectorResult createConnector(CreateConnectorRequest createConnectorRequest)
Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server. For more details about connectors, see Configure AS2 connectors and Create SFTP connectors.
You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (
SftpConfig).
createConnectorRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.ResourceExistsException - The requested resource does not exist, or exists in a region other than the one specified for the
command.CreateProfileResult createProfile(CreateProfileRequest createProfileRequest)
Creates the local or partner profile to use for AS2 transfers.
createProfileRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.CreateServerResult createServer(CreateServerRequest createServerRequest)
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.
createServerRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.ResourceExistsException - The requested resource does not exist, or exists in a region other than the one specified for the
command.AccessDeniedException - You do not have sufficient access to perform this action.CreateUserResult createUser(CreateUserRequest createUserRequest)
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.
createUserRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.ResourceExistsException - The requested resource does not exist, or exists in a region other than the one specified for the
command.CreateWorkflowResult createWorkflow(CreateWorkflowRequest createWorkflowRequest)
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.
createWorkflowRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.ResourceExistsException - The requested resource does not exist, or exists in a region other than the one specified for the
command.AccessDeniedException - You do not have sufficient access to perform this action.DeleteAccessResult deleteAccess(DeleteAccessRequest deleteAccessRequest)
Allows you to delete the access specified in the ServerID and ExternalID parameters.
deleteAccessRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.DeleteAgreementResult deleteAgreement(DeleteAgreementRequest deleteAgreementRequest)
Delete the agreement that's specified in the provided AgreementId.
deleteAgreementRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.DeleteCertificateResult deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
Deletes the certificate that's specified in the CertificateId parameter.
deleteCertificateRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.DeleteConnectorResult deleteConnector(DeleteConnectorRequest deleteConnectorRequest)
Deletes the connector that's specified in the provided ConnectorId.
deleteConnectorRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.DeleteHostKeyResult deleteHostKey(DeleteHostKeyRequest deleteHostKeyRequest)
Deletes the host key that's specified in the HostKeyId parameter.
deleteHostKeyRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.DeleteProfileResult deleteProfile(DeleteProfileRequest deleteProfileRequest)
Deletes the profile that's specified in the ProfileId parameter.
deleteProfileRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.DeleteServerResult deleteServer(DeleteServerRequest deleteServerRequest)
Deletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.
deleteServerRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.AccessDeniedException - You do not have sufficient access to perform this action.DeleteSshPublicKeyResult deleteSshPublicKey(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest)
Deletes a user's Secure Shell (SSH) public key.
deleteSshPublicKeyRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the user belonging to a file transfer protocol-enabled server you specify.
No response returns from this operation.
When you delete a user from a server, the user's information is lost.
deleteUserRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.DeleteWorkflowResult deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest)
Deletes the specified workflow.
deleteWorkflowRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.AccessDeniedException - You do not have sufficient access to perform this action.DescribeAccessResult describeAccess(DescribeAccessRequest describeAccessRequest)
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.
describeAccessRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.DescribeAgreementResult describeAgreement(DescribeAgreementRequest describeAgreementRequest)
Describes the agreement that's identified by the AgreementId.
describeAgreementRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.DescribeCertificateResult describeCertificate(DescribeCertificateRequest describeCertificateRequest)
Describes the certificate that's identified by the CertificateId.
describeCertificateRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.DescribeConnectorResult describeConnector(DescribeConnectorRequest describeConnectorRequest)
Describes the connector that's identified by the ConnectorId.
describeConnectorRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.DescribeExecutionResult describeExecution(DescribeExecutionRequest describeExecutionRequest)
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.
describeExecutionRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.DescribeHostKeyResult describeHostKey(DescribeHostKeyRequest describeHostKeyRequest)
Returns the details of the host key that's specified by the HostKeyId and ServerId.
describeHostKeyRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.DescribeProfileResult describeProfile(DescribeProfileRequest describeProfileRequest)
Returns the details of the profile that's specified by the ProfileId.
describeProfileRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.DescribeSecurityPolicyResult describeSecurityPolicy(DescribeSecurityPolicyRequest describeSecurityPolicyRequest)
Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.
describeSecurityPolicyRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.DescribeServerResult describeServer(DescribeServerRequest describeServerRequest)
Describes a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
The response contains a description of a server's properties. When you set EndpointType to VPC, the
response will contain the EndpointDetails.
describeServerRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.DescribeUserResult describeUser(DescribeUserRequest describeUserRequest)
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property.
The response from this call returns the properties of the user associated with the ServerId value
that was specified.
describeUserRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.DescribeWorkflowResult describeWorkflow(DescribeWorkflowRequest describeWorkflowRequest)
Describes the specified workflow.
describeWorkflowRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.ImportCertificateResult importCertificate(ImportCertificateRequest importCertificateRequest)
Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.
importCertificateRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.ImportHostKeyResult importHostKey(ImportHostKeyRequest importHostKeyRequest)
Adds a host key to the server that's specified by the ServerId parameter.
importHostKeyRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.ResourceExistsException - The requested resource does not exist, or exists in a region other than the one specified for the
command.ImportSshPublicKeyResult importSshPublicKey(ImportSshPublicKeyRequest importSshPublicKeyRequest)
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.
importSshPublicKeyRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.ResourceExistsException - The requested resource does not exist, or exists in a region other than the one specified for the
command.ListAccessesResult listAccesses(ListAccessesRequest listAccessesRequest)
Lists the details for all the accesses you have on your server.
listAccessesRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InvalidNextTokenException - The NextToken parameter that was passed is invalid.ListAgreementsResult listAgreements(ListAgreementsRequest listAgreementsRequest)
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.
listAgreementsRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InvalidNextTokenException - The NextToken parameter that was passed is invalid.ListCertificatesResult listCertificates(ListCertificatesRequest listCertificatesRequest)
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.
listCertificatesRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InvalidNextTokenException - The NextToken parameter that was passed is invalid.ListConnectorsResult listConnectors(ListConnectorsRequest listConnectorsRequest)
Lists the connectors for the specified Region.
listConnectorsRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InvalidNextTokenException - The NextToken parameter that was passed is invalid.ListExecutionsResult listExecutions(ListExecutionsRequest listExecutionsRequest)
Lists all in-progress executions for the specified workflow.
If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound
exception.
listExecutionsRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InvalidNextTokenException - The NextToken parameter that was passed is invalid.ListHostKeysResult listHostKeys(ListHostKeysRequest listHostKeysRequest)
Returns a list of host keys for the server that's specified by the ServerId parameter.
listHostKeysRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InvalidNextTokenException - The NextToken parameter that was passed is invalid.ListProfilesResult listProfiles(ListProfilesRequest listProfilesRequest)
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.
listProfilesRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InvalidNextTokenException - The NextToken parameter that was passed is invalid.ListSecurityPoliciesResult listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
Lists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.
listSecurityPoliciesRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InvalidNextTokenException - The NextToken parameter that was passed is invalid.ListServersResult listServers(ListServersRequest listServersRequest)
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
listServersRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InvalidNextTokenException - The NextToken parameter that was passed is invalid.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
listTagsForResourceRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InvalidNextTokenException - The NextToken parameter that was passed is invalid.ListUsersResult listUsers(ListUsersRequest listUsersRequest)
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
listUsersRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InvalidNextTokenException - The NextToken parameter that was passed is invalid.ListWorkflowsResult listWorkflows(ListWorkflowsRequest listWorkflowsRequest)
Lists all workflows associated with your Amazon Web Services account for your current region.
listWorkflowsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InvalidNextTokenException - The NextToken parameter that was passed is invalid.SendWorkflowStepStateResult sendWorkflowStepState(SendWorkflowStepStateRequest sendWorkflowStepStateRequest)
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.
sendWorkflowStepStateRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.AccessDeniedException - You do not have sufficient access to perform this action.StartDirectoryListingResult startDirectoryListing(StartDirectoryListingRequest startDirectoryListingRequest)
Retrieves a list of the contents of a directory from a remote SFTP server. You specify the connector ID, the
output path, and the remote directory path. You can also specify the optional MaxItems value to
control the maximum number of items that are listed from the remote directory. This API returns a list of all
files and directories in the remote directory (up to the maximum value), but does not return files or folders in
sub-directories. That is, it only returns a list of files and directories one-level deep.
After you receive the listing file, you can provide the files that you want to transfer to the
RetrieveFilePaths parameter of the StartFileTransfer API call.
The naming convention for the output file is connector-ID-listing-ID.json. The output
file contains the following information:
filePath: the complete path of a remote file, relative to the directory of the listing request for
your SFTP connector on the remote server.
modifiedTimestamp: the last time the file was modified, in UTC time format. This field is optional.
If the remote file attributes don't contain a timestamp, it is omitted from the file listing.
size: the size of the file, in bytes. This field is optional. If the remote file attributes don't
contain a file size, it is omitted from the file listing.
path: the complete path of a remote directory, relative to the directory of the listing request for
your SFTP connector on the remote server.
truncated: a flag indicating whether the list output contains all of the items contained in the
remote directory or not. If your Truncated output value is true, you can increase the value provided
in the optional max-items input attribute to be able to list more items (up to the maximum allowed
list size of 10,000 items).
startDirectoryListingRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.StartFileTransferResult startFileTransfer(StartFileTransferRequest startFileTransferRequest)
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 Amazon Web Services storage, you specify one or more
RetrieveFilePaths 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.
startFileTransferRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.StartServerResult startServer(StartServerRequest startServerRequest)
Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It
has no impact on a server that is already ONLINE. An ONLINE server can accept and
process file transfer jobs.
The state of STARTING indicates that the server is in an intermediate state, either not fully able
to respond, or not fully online. The values of START_FAILED can indicate an error condition.
No response is returned from this call.
startServerRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.StopServerResult stopServer(StopServerRequest stopServerRequest)
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.
stopServerRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
There is no response returned from this call.
tagResourceRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.TestConnectionResult testConnection(TestConnectionRequest testConnectionRequest)
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 local Amazon Web Services storage and a trading partner's SFTP server.
testConnectionRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.TestIdentityProviderResult testIdentityProvider(TestIdentityProviderRequest testIdentityProviderRequest)
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).
testIdentityProviderRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
No response is returned from this call.
untagResourceRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.UpdateAccessResult updateAccess(UpdateAccessRequest updateAccessRequest)
Allows you to update parameters for the access specified in the ServerID and ExternalID
parameters.
updateAccessRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.ResourceExistsException - The requested resource does not exist, or exists in a region other than the one specified for the
command.UpdateAgreementResult updateAgreement(UpdateAgreementRequest updateAgreementRequest)
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.
updateAgreementRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.ResourceExistsException - The requested resource does not exist, or exists in a region other than the one specified for the
command.UpdateCertificateResult updateCertificate(UpdateCertificateRequest updateCertificateRequest)
Updates the active and inactive dates for a certificate.
updateCertificateRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.UpdateConnectorResult updateConnector(UpdateConnectorRequest updateConnectorRequest)
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.
updateConnectorRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.ResourceExistsException - The requested resource does not exist, or exists in a region other than the one specified for the
command.UpdateHostKeyResult updateHostKey(UpdateHostKeyRequest updateHostKeyRequest)
Updates the description for the host key that's specified by the ServerId and HostKeyId
parameters.
updateHostKeyRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.UpdateProfileResult updateProfile(UpdateProfileRequest updateProfileRequest)
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.
updateProfileRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.UpdateServerResult updateServer(UpdateServerRequest updateServerRequest)
Updates the file transfer protocol-enabled server's properties after that server has been created.
The UpdateServer call returns the ServerId of the server you updated.
updateServerRequest - ConflictException - This exception is thrown when the 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.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.ResourceExistsException - The requested resource does not exist, or exists in a region other than the one specified for the
command.AccessDeniedException - You do not have sufficient access to perform this action.UpdateUserResult updateUser(UpdateUserRequest updateUserRequest)
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.
In the console, you can select Restricted when you create or update a user. This ensures that the user
can't access anything outside of their home directory. The programmatic way to configure this behavior is to
update the user. Set their HomeDirectoryType to LOGICAL, and specify
HomeDirectoryMappings with Entry as root (/) and Target as
their home directory.
For example, if the user's home directory is /test/admin-user, the following command updates the
user so that their configuration in the console shows the Restricted flag as selected.
aws transfer update-user --server-id <server-id> --user-name admin-user --home-directory-type LOGICAL --home-directory-mappings "[{\"Entry\":\"/\", \"Target\":\"/test/admin-user\"}]"
updateUserRequest - ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ThrottlingException - The request was denied due to request throttling.InternalServiceErrorException - This exception is thrown when an error occurs in the Transfer Family service.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.AWSTransferWaiters waiters()