@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSTransferClient extends AmazonWebServiceClient implements AWSTransfer
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 |
|---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AWSTransferClientBuilder |
builder() |
CreateAccessResult |
createAccess(CreateAccessRequest request)
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 request)
Creates an agreement.
|
CreateConnectorResult |
createConnector(CreateConnectorRequest request)
Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.
|
CreateProfileResult |
createProfile(CreateProfileRequest request)
Creates the local or partner profile to use for AS2 transfers.
|
CreateServerResult |
createServer(CreateServerRequest request)
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.
|
CreateUserResult |
createUser(CreateUserRequest request)
Creates a user and associates them with an existing file transfer protocol-enabled server.
|
CreateWorkflowResult |
createWorkflow(CreateWorkflowRequest request)
Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer
completes.
|
DeleteAccessResult |
deleteAccess(DeleteAccessRequest request)
Allows you to delete the access specified in the
ServerID and ExternalID parameters. |
DeleteAgreementResult |
deleteAgreement(DeleteAgreementRequest request)
Delete the agreement that's specified in the provided
AgreementId. |
DeleteCertificateResult |
deleteCertificate(DeleteCertificateRequest request)
Deletes the certificate that's specified in the
CertificateId parameter. |
DeleteConnectorResult |
deleteConnector(DeleteConnectorRequest request)
Deletes the connector that's specified in the provided
ConnectorId. |
DeleteHostKeyResult |
deleteHostKey(DeleteHostKeyRequest request)
Deletes the host key that's specified in the
HostKeyId parameter. |
DeleteProfileResult |
deleteProfile(DeleteProfileRequest request)
Deletes the profile that's specified in the
ProfileId parameter. |
DeleteServerResult |
deleteServer(DeleteServerRequest request)
Deletes the file transfer protocol-enabled server that you specify.
|
DeleteSshPublicKeyResult |
deleteSshPublicKey(DeleteSshPublicKeyRequest request)
Deletes a user's Secure Shell (SSH) public key.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
Deletes the user belonging to a file transfer protocol-enabled server you specify.
|
DeleteWorkflowResult |
deleteWorkflow(DeleteWorkflowRequest request)
Deletes the specified workflow.
|
DescribeAccessResult |
describeAccess(DescribeAccessRequest request)
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 request)
Describes the agreement that's identified by the
AgreementId. |
DescribeCertificateResult |
describeCertificate(DescribeCertificateRequest request)
Describes the certificate that's identified by the
CertificateId. |
DescribeConnectorResult |
describeConnector(DescribeConnectorRequest request)
Describes the connector that's identified by the
ConnectorId. |
DescribeExecutionResult |
describeExecution(DescribeExecutionRequest request)
You can use
DescribeExecution to check the details of the execution of the specified workflow. |
DescribeHostKeyResult |
describeHostKey(DescribeHostKeyRequest request)
Returns the details of the host key that's specified by the
HostKeyId and ServerId. |
DescribeProfileResult |
describeProfile(DescribeProfileRequest request)
Returns the details of the profile that's specified by the
ProfileId. |
DescribeSecurityPolicyResult |
describeSecurityPolicy(DescribeSecurityPolicyRequest request)
Describes the security policy that is attached to your file transfer protocol-enabled server.
|
DescribeServerResult |
describeServer(DescribeServerRequest request)
Describes a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
DescribeUserResult |
describeUser(DescribeUserRequest request)
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property. |
DescribeWorkflowResult |
describeWorkflow(DescribeWorkflowRequest request)
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 request)
Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner
profiles.
|
ImportHostKeyResult |
importHostKey(ImportHostKeyRequest request)
Adds a host key to the server that's specified by the
ServerId parameter. |
ImportSshPublicKeyResult |
importSshPublicKey(ImportSshPublicKeyRequest request)
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 request)
Lists the details for all the accesses you have on your server.
|
ListAgreementsResult |
listAgreements(ListAgreementsRequest request)
Returns a list of the agreements for the server that's identified by the
ServerId that you supply. |
ListCertificatesResult |
listCertificates(ListCertificatesRequest request)
Returns a list of the current certificates that have been imported into Transfer Family.
|
ListConnectorsResult |
listConnectors(ListConnectorsRequest request)
Lists the connectors for the specified Region.
|
ListExecutionsResult |
listExecutions(ListExecutionsRequest request)
Lists all in-progress executions for the specified workflow.
|
ListHostKeysResult |
listHostKeys(ListHostKeysRequest request)
Returns a list of host keys for the server that's specified by the
ServerId parameter. |
ListProfilesResult |
listProfiles(ListProfilesRequest request)
Returns a list of the profiles for your system.
|
ListSecurityPoliciesResult |
listSecurityPolicies(ListSecurityPoliciesRequest request)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
|
ListServersResult |
listServers(ListServersRequest request)
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
|
ListUsersResult |
listUsers(ListUsersRequest request)
Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
ListWorkflowsResult |
listWorkflows(ListWorkflowsRequest request)
Lists all workflows associated with your Amazon Web Services account for your current region.
|
SendWorkflowStepStateResult |
sendWorkflowStepState(SendWorkflowStepStateRequest request)
Sends a callback for asynchronous custom steps.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartFileTransferResult |
startFileTransfer(StartFileTransferRequest request)
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
|
StartServerResult |
startServer(StartServerRequest request)
Changes the state of a file transfer protocol-enabled server from
OFFLINE to ONLINE. |
StopServerResult |
stopServer(StopServerRequest request)
Changes the state of a file transfer protocol-enabled server from
ONLINE to OFFLINE. |
TagResourceResult |
tagResource(TagResourceRequest request)
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
|
TestConnectionResult |
testConnection(TestConnectionRequest request)
Tests whether your SFTP connector is set up successfully.
|
TestIdentityProviderResult |
testIdentityProvider(TestIdentityProviderRequest request)
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 request)
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
|
UpdateAccessResult |
updateAccess(UpdateAccessRequest request)
Allows you to update parameters for the access specified in the
ServerID and ExternalID
parameters. |
UpdateAgreementResult |
updateAgreement(UpdateAgreementRequest request)
Updates some of the parameters for an existing agreement.
|
UpdateCertificateResult |
updateCertificate(UpdateCertificateRequest request)
Updates the active and inactive dates for a certificate.
|
UpdateConnectorResult |
updateConnector(UpdateConnectorRequest request)
Updates some of the parameters for an existing connector.
|
UpdateHostKeyResult |
updateHostKey(UpdateHostKeyRequest request)
Updates the description for the host key that's specified by the
ServerId and HostKeyId
parameters. |
UpdateProfileResult |
updateProfile(UpdateProfileRequest request)
Updates some of the parameters for an existing profile.
|
UpdateServerResult |
updateServer(UpdateServerRequest request)
Updates the file transfer protocol-enabled server's properties after that server has been created.
|
UpdateUserResult |
updateUser(UpdateUserRequest request)
Assigns new properties to a user.
|
AWSTransferWaiters |
waiters() |
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetprotected static final ClientConfigurationFactory configFactory
public static AWSTransferClientBuilder builder()
public CreateAccessResult createAccess(CreateAccessRequest request)
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.
createAccess in interface AWSTransfercreateAccessRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceExistsException - The requested resource does not exist.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public CreateAgreementResult createAgreement(CreateAgreementRequest request)
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.
createAgreement in interface AWSTransfercreateAgreementRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceExistsException - The requested resource does not exist.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.ThrottlingException - The request was denied due to request throttling.public CreateConnectorResult createConnector(CreateConnectorRequest request)
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 Create AS2 connectors and Create SFTP connectors.
You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (
SftpConfig).
createConnector in interface AWSTransfercreateConnectorRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceExistsException - The requested resource does not exist.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.ThrottlingException - The request was denied due to request throttling.public CreateProfileResult createProfile(CreateProfileRequest request)
Creates the local or partner profile to use for AS2 transfers.
createProfile in interface AWSTransfercreateProfileRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.ThrottlingException - The request was denied due to request throttling.public CreateServerResult createServer(CreateServerRequest request)
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.
createServer in interface AWSTransfercreateServerRequest - AccessDeniedException - You do not have sufficient access to perform this action.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceExistsException - The requested resource does not exist.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.ThrottlingException - The request was denied due to request throttling.public CreateUserResult createUser(CreateUserRequest request)
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.
createUser in interface AWSTransfercreateUserRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceExistsException - The requested resource does not exist.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public CreateWorkflowResult createWorkflow(CreateWorkflowRequest request)
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.
createWorkflow in interface AWSTransfercreateWorkflowRequest - AccessDeniedException - You do not have sufficient access to perform this action.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceExistsException - The requested resource does not exist.ThrottlingException - The request was denied due to request throttling.public DeleteAccessResult deleteAccess(DeleteAccessRequest request)
Allows you to delete the access specified in the ServerID and ExternalID parameters.
deleteAccess in interface AWSTransferdeleteAccessRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public DeleteAgreementResult deleteAgreement(DeleteAgreementRequest request)
Delete the agreement that's specified in the provided AgreementId.
deleteAgreement in interface AWSTransferdeleteAgreementRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public DeleteCertificateResult deleteCertificate(DeleteCertificateRequest request)
Deletes the certificate that's specified in the CertificateId parameter.
deleteCertificate in interface AWSTransferdeleteCertificateRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public DeleteConnectorResult deleteConnector(DeleteConnectorRequest request)
Deletes the connector that's specified in the provided ConnectorId.
deleteConnector in interface AWSTransferdeleteConnectorRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public DeleteHostKeyResult deleteHostKey(DeleteHostKeyRequest request)
Deletes the host key that's specified in the HostKeyId parameter.
deleteHostKey in interface AWSTransferdeleteHostKeyRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.ThrottlingException - The request was denied due to request throttling.public DeleteProfileResult deleteProfile(DeleteProfileRequest request)
Deletes the profile that's specified in the ProfileId parameter.
deleteProfile in interface AWSTransferdeleteProfileRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public DeleteServerResult deleteServer(DeleteServerRequest request)
Deletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.
deleteServer in interface AWSTransferdeleteServerRequest - AccessDeniedException - You do not have sufficient access to perform this action.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public DeleteSshPublicKeyResult deleteSshPublicKey(DeleteSshPublicKeyRequest request)
Deletes a user's Secure Shell (SSH) public key.
deleteSshPublicKey in interface AWSTransferdeleteSshPublicKeyRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.ThrottlingException - The request was denied due to request throttling.public DeleteUserResult deleteUser(DeleteUserRequest request)
Deletes the user belonging to a file transfer protocol-enabled server you specify.
No response returns from this operation.
When you delete a user from a server, the user's information is lost.
deleteUser in interface AWSTransferdeleteUserRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public DeleteWorkflowResult deleteWorkflow(DeleteWorkflowRequest request)
Deletes the specified workflow.
deleteWorkflow in interface AWSTransferdeleteWorkflowRequest - AccessDeniedException - You do not have sufficient access to perform this action.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public DescribeAccessResult describeAccess(DescribeAccessRequest request)
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.
describeAccess in interface AWSTransferdescribeAccessRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public DescribeAgreementResult describeAgreement(DescribeAgreementRequest request)
Describes the agreement that's identified by the AgreementId.
describeAgreement in interface AWSTransferdescribeAgreementRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public DescribeCertificateResult describeCertificate(DescribeCertificateRequest request)
Describes the certificate that's identified by the CertificateId.
describeCertificate in interface AWSTransferdescribeCertificateRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public DescribeConnectorResult describeConnector(DescribeConnectorRequest request)
Describes the connector that's identified by the ConnectorId.
describeConnector in interface AWSTransferdescribeConnectorRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public DescribeExecutionResult describeExecution(DescribeExecutionRequest request)
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.
describeExecution in interface AWSTransferdescribeExecutionRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public DescribeHostKeyResult describeHostKey(DescribeHostKeyRequest request)
Returns the details of the host key that's specified by the HostKeyId and ServerId.
describeHostKey in interface AWSTransferdescribeHostKeyRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public DescribeProfileResult describeProfile(DescribeProfileRequest request)
Returns the details of the profile that's specified by the ProfileId.
describeProfile in interface AWSTransferdescribeProfileRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public DescribeSecurityPolicyResult describeSecurityPolicy(DescribeSecurityPolicyRequest request)
Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies.
describeSecurityPolicy in interface AWSTransferdescribeSecurityPolicyRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public DescribeServerResult describeServer(DescribeServerRequest request)
Describes a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
The response contains a description of a server's properties. When you set EndpointType to VPC, the
response will contain the EndpointDetails.
describeServer in interface AWSTransferdescribeServerRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public DescribeUserResult describeUser(DescribeUserRequest request)
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property.
The response from this call returns the properties of the user associated with the ServerId value
that was specified.
describeUser in interface AWSTransferdescribeUserRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public DescribeWorkflowResult describeWorkflow(DescribeWorkflowRequest request)
Describes the specified workflow.
describeWorkflow in interface AWSTransferdescribeWorkflowRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public ImportCertificateResult importCertificate(ImportCertificateRequest request)
Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.
importCertificate in interface AWSTransferimportCertificateRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public ImportHostKeyResult importHostKey(ImportHostKeyRequest request)
Adds a host key to the server that's specified by the ServerId parameter.
importHostKey in interface AWSTransferimportHostKeyRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceExistsException - The requested resource does not exist.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.ThrottlingException - The request was denied due to request throttling.public ImportSshPublicKeyResult importSshPublicKey(ImportSshPublicKeyRequest request)
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.
importSshPublicKey in interface AWSTransferimportSshPublicKeyRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceExistsException - The requested resource does not exist.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.ThrottlingException - The request was denied due to request throttling.public ListAccessesResult listAccesses(ListAccessesRequest request)
Lists the details for all the accesses you have on your server.
listAccesses in interface AWSTransferlistAccessesRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidNextTokenException - The NextToken parameter that was passed is invalid.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public ListAgreementsResult listAgreements(ListAgreementsRequest request)
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.
listAgreements in interface AWSTransferlistAgreementsRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidNextTokenException - The NextToken parameter that was passed is invalid.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public ListCertificatesResult listCertificates(ListCertificatesRequest request)
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.
listCertificates in interface AWSTransferlistCertificatesRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidNextTokenException - The NextToken parameter that was passed is invalid.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public ListConnectorsResult listConnectors(ListConnectorsRequest request)
Lists the connectors for the specified Region.
listConnectors in interface AWSTransferlistConnectorsRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidNextTokenException - The NextToken parameter that was passed is invalid.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public ListExecutionsResult listExecutions(ListExecutionsRequest request)
Lists all in-progress executions for the specified workflow.
If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound
exception.
listExecutions in interface AWSTransferlistExecutionsRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidNextTokenException - The NextToken parameter that was passed is invalid.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public ListHostKeysResult listHostKeys(ListHostKeysRequest request)
Returns a list of host keys for the server that's specified by the ServerId parameter.
listHostKeys in interface AWSTransferlistHostKeysRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidNextTokenException - The NextToken parameter that was passed is invalid.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public ListProfilesResult listProfiles(ListProfilesRequest request)
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.
listProfiles in interface AWSTransferlistProfilesRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidNextTokenException - The NextToken parameter that was passed is invalid.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public ListSecurityPoliciesResult listSecurityPolicies(ListSecurityPoliciesRequest request)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
listSecurityPolicies in interface AWSTransferlistSecurityPoliciesRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidNextTokenException - The NextToken parameter that was passed is invalid.InvalidRequestException - This exception is thrown when the client submits a malformed request.public ListServersResult listServers(ListServersRequest request)
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
listServers in interface AWSTransferlistServersRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidNextTokenException - The NextToken parameter that was passed is invalid.InvalidRequestException - This exception is thrown when the client submits a malformed request.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
listTagsForResource in interface AWSTransferlistTagsForResourceRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidNextTokenException - The NextToken parameter that was passed is invalid.InvalidRequestException - This exception is thrown when the client submits a malformed request.public ListUsersResult listUsers(ListUsersRequest request)
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
listUsers in interface AWSTransferlistUsersRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidNextTokenException - The NextToken parameter that was passed is invalid.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public ListWorkflowsResult listWorkflows(ListWorkflowsRequest request)
Lists all workflows associated with your Amazon Web Services account for your current region.
listWorkflows in interface AWSTransferlistWorkflowsRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidNextTokenException - The NextToken parameter that was passed is invalid.InvalidRequestException - This exception is thrown when the client submits a malformed request.public SendWorkflowStepStateResult sendWorkflowStepState(SendWorkflowStepStateRequest request)
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.
sendWorkflowStepState in interface AWSTransfersendWorkflowStepStateRequest - AccessDeniedException - You do not have sufficient access to perform this action.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.ThrottlingException - The request was denied due to request throttling.public StartFileTransferResult startFileTransfer(StartFileTransferRequest request)
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
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.
startFileTransfer in interface AWSTransferstartFileTransferRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.ThrottlingException - The request was denied due to request throttling.public StartServerResult startServer(StartServerRequest request)
Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It
has no impact on a server that is already ONLINE. An ONLINE server can accept and
process file transfer jobs.
The state of STARTING indicates that the server is in an intermediate state, either not fully able
to respond, or not fully online. The values of START_FAILED can indicate an error condition.
No response is returned from this call.
startServer in interface AWSTransferstartServerRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.ThrottlingException - The request was denied due to request throttling.public StopServerResult stopServer(StopServerRequest request)
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.
stopServer in interface AWSTransferstopServerRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.ThrottlingException - The request was denied due to request throttling.public TagResourceResult tagResource(TagResourceRequest request)
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
There is no response returned from this call.
tagResource in interface AWSTransfertagResourceRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public TestConnectionResult testConnection(TestConnectionRequest request)
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.
testConnection in interface AWSTransfertestConnectionRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public TestIdentityProviderResult testIdentityProvider(TestIdentityProviderRequest request)
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).
testIdentityProvider in interface AWSTransfertestIdentityProviderRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public UntagResourceResult untagResource(UntagResourceRequest request)
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
No response is returned from this call.
untagResource in interface AWSTransferuntagResourceRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.public UpdateAccessResult updateAccess(UpdateAccessRequest request)
Allows you to update parameters for the access specified in the ServerID and ExternalID
parameters.
updateAccess in interface AWSTransferupdateAccessRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceExistsException - The requested resource does not exist.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.ThrottlingException - The request was denied due to request throttling.public UpdateAgreementResult updateAgreement(UpdateAgreementRequest request)
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.
updateAgreement in interface AWSTransferupdateAgreementRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceExistsException - The requested resource does not exist.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.ThrottlingException - The request was denied due to request throttling.public UpdateCertificateResult updateCertificate(UpdateCertificateRequest request)
Updates the active and inactive dates for a certificate.
updateCertificate in interface AWSTransferupdateCertificateRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.ThrottlingException - The request was denied due to request throttling.public UpdateConnectorResult updateConnector(UpdateConnectorRequest request)
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.
updateConnector in interface AWSTransferupdateConnectorRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceExistsException - The requested resource does not exist.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.ThrottlingException - The request was denied due to request throttling.public UpdateHostKeyResult updateHostKey(UpdateHostKeyRequest request)
Updates the description for the host key that's specified by the ServerId and HostKeyId
parameters.
updateHostKey in interface AWSTransferupdateHostKeyRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.ThrottlingException - The request was denied due to request throttling.public UpdateProfileResult updateProfile(UpdateProfileRequest request)
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.
updateProfile in interface AWSTransferupdateProfileRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.ThrottlingException - The request was denied due to request throttling.public UpdateServerResult updateServer(UpdateServerRequest request)
Updates the file transfer protocol-enabled server's properties after that server has been created.
The UpdateServer call returns the ServerId of the server you updated.
updateServer in interface AWSTransferupdateServerRequest - AccessDeniedException - You do not have sufficient access to perform this action.ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.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.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceExistsException - The requested resource does not exist.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.ThrottlingException - The request was denied due to request throttling.public UpdateUserResult updateUser(UpdateUserRequest request)
Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory,
role, and policy for the UserName and ServerId you specify.
The response returns the ServerId and the UserName for the updated user.
updateUser in interface AWSTransferupdateUserRequest - ServiceUnavailableException - The request has failed because the Amazon Web ServicesTransfer Family service is not available.InternalServiceErrorException - This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.InvalidRequestException - This exception is thrown when the client submits a malformed request.ResourceNotFoundException - This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.ThrottlingException - The request was denied due to request throttling.public 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 the request.
getCachedResponseMetadata in interface AWSTransferrequest - The originally executed requestpublic AWSTransferWaiters waiters()
waiters in interface AWSTransferpublic void shutdown()
AWSTransfershutdown in interface AWSTransfershutdown in class AmazonWebServiceClientCopyright © 2023. All rights reserved.