Interface TransferAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic TransferAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aTransferAsyncClient
.static TransferAsyncClient
create()
Create aTransferAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateAccessResponse> createAccess
(Consumer<CreateAccessRequest.Builder> 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.default CompletableFuture
<CreateAccessResponse> 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.default CompletableFuture
<CreateAgreementResponse> createAgreement
(Consumer<CreateAgreementRequest.Builder> createAgreementRequest) Creates an agreement.default CompletableFuture
<CreateAgreementResponse> createAgreement
(CreateAgreementRequest createAgreementRequest) Creates an agreement.default CompletableFuture
<CreateConnectorResponse> createConnector
(Consumer<CreateConnectorRequest.Builder> createConnectorRequest) Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.default CompletableFuture
<CreateConnectorResponse> createConnector
(CreateConnectorRequest createConnectorRequest) Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.default CompletableFuture
<CreateProfileResponse> createProfile
(Consumer<CreateProfileRequest.Builder> createProfileRequest) Creates the local or partner profile to use for AS2 transfers.default CompletableFuture
<CreateProfileResponse> createProfile
(CreateProfileRequest createProfileRequest) Creates the local or partner profile to use for AS2 transfers.default CompletableFuture
<CreateServerResponse> createServer
(Consumer<CreateServerRequest.Builder> createServerRequest) Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.default CompletableFuture
<CreateServerResponse> createServer
(CreateServerRequest createServerRequest) Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.default CompletableFuture
<CreateUserResponse> createUser
(Consumer<CreateUserRequest.Builder> createUserRequest) Creates a user and associates them with an existing file transfer protocol-enabled server.default CompletableFuture
<CreateUserResponse> createUser
(CreateUserRequest createUserRequest) Creates a user and associates them with an existing file transfer protocol-enabled server.default CompletableFuture
<CreateWorkflowResponse> createWorkflow
(Consumer<CreateWorkflowRequest.Builder> createWorkflowRequest) Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.default CompletableFuture
<CreateWorkflowResponse> createWorkflow
(CreateWorkflowRequest createWorkflowRequest) Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.default CompletableFuture
<DeleteAccessResponse> deleteAccess
(Consumer<DeleteAccessRequest.Builder> deleteAccessRequest) Allows you to delete the access specified in theServerID
andExternalID
parameters.default CompletableFuture
<DeleteAccessResponse> deleteAccess
(DeleteAccessRequest deleteAccessRequest) Allows you to delete the access specified in theServerID
andExternalID
parameters.default CompletableFuture
<DeleteAgreementResponse> deleteAgreement
(Consumer<DeleteAgreementRequest.Builder> deleteAgreementRequest) Delete the agreement that's specified in the providedAgreementId
.default CompletableFuture
<DeleteAgreementResponse> deleteAgreement
(DeleteAgreementRequest deleteAgreementRequest) Delete the agreement that's specified in the providedAgreementId
.deleteCertificate
(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest) Deletes the certificate that's specified in theCertificateId
parameter.deleteCertificate
(DeleteCertificateRequest deleteCertificateRequest) Deletes the certificate that's specified in theCertificateId
parameter.default CompletableFuture
<DeleteConnectorResponse> deleteConnector
(Consumer<DeleteConnectorRequest.Builder> deleteConnectorRequest) Deletes the connector that's specified in the providedConnectorId
.default CompletableFuture
<DeleteConnectorResponse> deleteConnector
(DeleteConnectorRequest deleteConnectorRequest) Deletes the connector that's specified in the providedConnectorId
.default CompletableFuture
<DeleteHostKeyResponse> deleteHostKey
(Consumer<DeleteHostKeyRequest.Builder> deleteHostKeyRequest) Deletes the host key that's specified in theHostKeyId
parameter.default CompletableFuture
<DeleteHostKeyResponse> deleteHostKey
(DeleteHostKeyRequest deleteHostKeyRequest) Deletes the host key that's specified in theHostKeyId
parameter.default CompletableFuture
<DeleteProfileResponse> deleteProfile
(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest) Deletes the profile that's specified in theProfileId
parameter.default CompletableFuture
<DeleteProfileResponse> deleteProfile
(DeleteProfileRequest deleteProfileRequest) Deletes the profile that's specified in theProfileId
parameter.default CompletableFuture
<DeleteServerResponse> deleteServer
(Consumer<DeleteServerRequest.Builder> deleteServerRequest) Deletes the file transfer protocol-enabled server that you specify.default CompletableFuture
<DeleteServerResponse> deleteServer
(DeleteServerRequest deleteServerRequest) Deletes the file transfer protocol-enabled server that you specify.deleteSshPublicKey
(Consumer<DeleteSshPublicKeyRequest.Builder> deleteSshPublicKeyRequest) Deletes a user's Secure Shell (SSH) public key.deleteSshPublicKey
(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest) Deletes a user's Secure Shell (SSH) public key.default CompletableFuture
<DeleteUserResponse> deleteUser
(Consumer<DeleteUserRequest.Builder> deleteUserRequest) Deletes the user belonging to a file transfer protocol-enabled server you specify.default CompletableFuture
<DeleteUserResponse> deleteUser
(DeleteUserRequest deleteUserRequest) Deletes the user belonging to a file transfer protocol-enabled server you specify.default CompletableFuture
<DeleteWorkflowResponse> deleteWorkflow
(Consumer<DeleteWorkflowRequest.Builder> deleteWorkflowRequest) Deletes the specified workflow.default CompletableFuture
<DeleteWorkflowResponse> deleteWorkflow
(DeleteWorkflowRequest deleteWorkflowRequest) Deletes the specified workflow.default CompletableFuture
<DescribeAccessResponse> describeAccess
(Consumer<DescribeAccessRequest.Builder> describeAccessRequest) Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by itsServerId
property and itsExternalId
.default CompletableFuture
<DescribeAccessResponse> describeAccess
(DescribeAccessRequest describeAccessRequest) Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by itsServerId
property and itsExternalId
.describeAgreement
(Consumer<DescribeAgreementRequest.Builder> describeAgreementRequest) Describes the agreement that's identified by theAgreementId
.describeAgreement
(DescribeAgreementRequest describeAgreementRequest) Describes the agreement that's identified by theAgreementId
.describeCertificate
(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest) Describes the certificate that's identified by theCertificateId
.describeCertificate
(DescribeCertificateRequest describeCertificateRequest) Describes the certificate that's identified by theCertificateId
.describeConnector
(Consumer<DescribeConnectorRequest.Builder> describeConnectorRequest) Describes the connector that's identified by theConnectorId.
describeConnector
(DescribeConnectorRequest describeConnectorRequest) Describes the connector that's identified by theConnectorId.
describeExecution
(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest) You can useDescribeExecution
to check the details of the execution of the specified workflow.describeExecution
(DescribeExecutionRequest describeExecutionRequest) You can useDescribeExecution
to check the details of the execution of the specified workflow.default CompletableFuture
<DescribeHostKeyResponse> describeHostKey
(Consumer<DescribeHostKeyRequest.Builder> describeHostKeyRequest) Returns the details of the host key that's specified by theHostKeyId
andServerId
.default CompletableFuture
<DescribeHostKeyResponse> describeHostKey
(DescribeHostKeyRequest describeHostKeyRequest) Returns the details of the host key that's specified by theHostKeyId
andServerId
.default CompletableFuture
<DescribeProfileResponse> describeProfile
(Consumer<DescribeProfileRequest.Builder> describeProfileRequest) Returns the details of the profile that's specified by theProfileId
.default CompletableFuture
<DescribeProfileResponse> describeProfile
(DescribeProfileRequest describeProfileRequest) Returns the details of the profile that's specified by theProfileId
.describeSecurityPolicy
(Consumer<DescribeSecurityPolicyRequest.Builder> describeSecurityPolicyRequest) Describes the security policy that is attached to your file transfer protocol-enabled server.describeSecurityPolicy
(DescribeSecurityPolicyRequest describeSecurityPolicyRequest) Describes the security policy that is attached to your file transfer protocol-enabled server.default CompletableFuture
<DescribeServerResponse> describeServer
(Consumer<DescribeServerRequest.Builder> describeServerRequest) Describes a file transfer protocol-enabled server that you specify by passing theServerId
parameter.default CompletableFuture
<DescribeServerResponse> describeServer
(DescribeServerRequest describeServerRequest) Describes a file transfer protocol-enabled server that you specify by passing theServerId
parameter.default CompletableFuture
<DescribeUserResponse> describeUser
(Consumer<DescribeUserRequest.Builder> describeUserRequest) Describes the user assigned to the specific file transfer protocol-enabled server, as identified by itsServerId
property.default CompletableFuture
<DescribeUserResponse> describeUser
(DescribeUserRequest describeUserRequest) Describes the user assigned to the specific file transfer protocol-enabled server, as identified by itsServerId
property.describeWorkflow
(Consumer<DescribeWorkflowRequest.Builder> describeWorkflowRequest) Describes the specified workflow.describeWorkflow
(DescribeWorkflowRequest describeWorkflowRequest) Describes the specified workflow.importCertificate
(Consumer<ImportCertificateRequest.Builder> importCertificateRequest) Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.importCertificate
(ImportCertificateRequest importCertificateRequest) Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.default CompletableFuture
<ImportHostKeyResponse> importHostKey
(Consumer<ImportHostKeyRequest.Builder> importHostKeyRequest) Adds a host key to the server that's specified by theServerId
parameter.default CompletableFuture
<ImportHostKeyResponse> importHostKey
(ImportHostKeyRequest importHostKeyRequest) Adds a host key to the server that's specified by theServerId
parameter.importSshPublicKey
(Consumer<ImportSshPublicKeyRequest.Builder> importSshPublicKeyRequest) Adds a Secure Shell (SSH) public key to a Transfer Family user identified by aUserName
value assigned to the specific file transfer protocol-enabled server, identified byServerId
.importSshPublicKey
(ImportSshPublicKeyRequest importSshPublicKeyRequest) Adds a Secure Shell (SSH) public key to a Transfer Family user identified by aUserName
value assigned to the specific file transfer protocol-enabled server, identified byServerId
.default CompletableFuture
<ListAccessesResponse> listAccesses
(Consumer<ListAccessesRequest.Builder> listAccessesRequest) Lists the details for all the accesses you have on your server.default CompletableFuture
<ListAccessesResponse> listAccesses
(ListAccessesRequest listAccessesRequest) Lists the details for all the accesses you have on your server.default ListAccessesPublisher
listAccessesPaginator
(Consumer<ListAccessesRequest.Builder> listAccessesRequest) This is a variant oflistAccesses(software.amazon.awssdk.services.transfer.model.ListAccessesRequest)
operation.default ListAccessesPublisher
listAccessesPaginator
(ListAccessesRequest listAccessesRequest) This is a variant oflistAccesses(software.amazon.awssdk.services.transfer.model.ListAccessesRequest)
operation.default CompletableFuture
<ListAgreementsResponse> listAgreements
(Consumer<ListAgreementsRequest.Builder> listAgreementsRequest) Returns a list of the agreements for the server that's identified by theServerId
that you supply.default CompletableFuture
<ListAgreementsResponse> listAgreements
(ListAgreementsRequest listAgreementsRequest) Returns a list of the agreements for the server that's identified by theServerId
that you supply.default ListAgreementsPublisher
listAgreementsPaginator
(Consumer<ListAgreementsRequest.Builder> listAgreementsRequest) This is a variant oflistAgreements(software.amazon.awssdk.services.transfer.model.ListAgreementsRequest)
operation.default ListAgreementsPublisher
listAgreementsPaginator
(ListAgreementsRequest listAgreementsRequest) This is a variant oflistAgreements(software.amazon.awssdk.services.transfer.model.ListAgreementsRequest)
operation.listCertificates
(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) Returns a list of the current certificates that have been imported into Transfer Family.listCertificates
(ListCertificatesRequest listCertificatesRequest) Returns a list of the current certificates that have been imported into Transfer Family.default ListCertificatesPublisher
listCertificatesPaginator
(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) This is a variant oflistCertificates(software.amazon.awssdk.services.transfer.model.ListCertificatesRequest)
operation.default ListCertificatesPublisher
listCertificatesPaginator
(ListCertificatesRequest listCertificatesRequest) This is a variant oflistCertificates(software.amazon.awssdk.services.transfer.model.ListCertificatesRequest)
operation.default CompletableFuture
<ListConnectorsResponse> listConnectors
(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest) Lists the connectors for the specified Region.default CompletableFuture
<ListConnectorsResponse> listConnectors
(ListConnectorsRequest listConnectorsRequest) Lists the connectors for the specified Region.default ListConnectorsPublisher
listConnectorsPaginator
(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest) This is a variant oflistConnectors(software.amazon.awssdk.services.transfer.model.ListConnectorsRequest)
operation.default ListConnectorsPublisher
listConnectorsPaginator
(ListConnectorsRequest listConnectorsRequest) This is a variant oflistConnectors(software.amazon.awssdk.services.transfer.model.ListConnectorsRequest)
operation.default CompletableFuture
<ListExecutionsResponse> listExecutions
(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest) Lists all in-progress executions for the specified workflow.default CompletableFuture
<ListExecutionsResponse> listExecutions
(ListExecutionsRequest listExecutionsRequest) Lists all in-progress executions for the specified workflow.default ListExecutionsPublisher
listExecutionsPaginator
(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest) This is a variant oflistExecutions(software.amazon.awssdk.services.transfer.model.ListExecutionsRequest)
operation.default ListExecutionsPublisher
listExecutionsPaginator
(ListExecutionsRequest listExecutionsRequest) This is a variant oflistExecutions(software.amazon.awssdk.services.transfer.model.ListExecutionsRequest)
operation.default CompletableFuture
<ListHostKeysResponse> listHostKeys
(Consumer<ListHostKeysRequest.Builder> listHostKeysRequest) Returns a list of host keys for the server that's specified by theServerId
parameter.default CompletableFuture
<ListHostKeysResponse> listHostKeys
(ListHostKeysRequest listHostKeysRequest) Returns a list of host keys for the server that's specified by theServerId
parameter.default CompletableFuture
<ListProfilesResponse> listProfiles
(Consumer<ListProfilesRequest.Builder> listProfilesRequest) Returns a list of the profiles for your system.default CompletableFuture
<ListProfilesResponse> listProfiles
(ListProfilesRequest listProfilesRequest) Returns a list of the profiles for your system.default ListProfilesPublisher
listProfilesPaginator
(Consumer<ListProfilesRequest.Builder> listProfilesRequest) This is a variant oflistProfiles(software.amazon.awssdk.services.transfer.model.ListProfilesRequest)
operation.default ListProfilesPublisher
listProfilesPaginator
(ListProfilesRequest listProfilesRequest) This is a variant oflistProfiles(software.amazon.awssdk.services.transfer.model.ListProfilesRequest)
operation.listSecurityPolicies
(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest) Lists the security policies that are attached to your file transfer protocol-enabled servers.listSecurityPolicies
(ListSecurityPoliciesRequest listSecurityPoliciesRequest) Lists the security policies that are attached to your file transfer protocol-enabled servers.default ListSecurityPoliciesPublisher
listSecurityPoliciesPaginator
(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest) This is a variant oflistSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest)
operation.default ListSecurityPoliciesPublisher
listSecurityPoliciesPaginator
(ListSecurityPoliciesRequest listSecurityPoliciesRequest) This is a variant oflistSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest)
operation.default CompletableFuture
<ListServersResponse> Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.default CompletableFuture
<ListServersResponse> listServers
(Consumer<ListServersRequest.Builder> listServersRequest) Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.default CompletableFuture
<ListServersResponse> listServers
(ListServersRequest listServersRequest) Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.default ListServersPublisher
This is a variant oflistServers(software.amazon.awssdk.services.transfer.model.ListServersRequest)
operation.default ListServersPublisher
listServersPaginator
(Consumer<ListServersRequest.Builder> listServersRequest) This is a variant oflistServers(software.amazon.awssdk.services.transfer.model.ListServersRequest)
operation.default ListServersPublisher
listServersPaginator
(ListServersRequest listServersRequest) This is a variant oflistServers(software.amazon.awssdk.services.transfer.model.ListServersRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.default ListTagsForResourcePublisher
listTagsForResourcePaginator
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest)
operation.default ListTagsForResourcePublisher
listTagsForResourcePaginator
(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest)
operation.default CompletableFuture
<ListUsersResponse> listUsers
(Consumer<ListUsersRequest.Builder> listUsersRequest) Lists the users for a file transfer protocol-enabled server that you specify by passing theServerId
parameter.default CompletableFuture
<ListUsersResponse> listUsers
(ListUsersRequest listUsersRequest) Lists the users for a file transfer protocol-enabled server that you specify by passing theServerId
parameter.default ListUsersPublisher
listUsersPaginator
(Consumer<ListUsersRequest.Builder> listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest)
operation.default ListUsersPublisher
listUsersPaginator
(ListUsersRequest listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest)
operation.default CompletableFuture
<ListWorkflowsResponse> listWorkflows
(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest) Lists all workflows associated with your Amazon Web Services account for your current region.default CompletableFuture
<ListWorkflowsResponse> listWorkflows
(ListWorkflowsRequest listWorkflowsRequest) Lists all workflows associated with your Amazon Web Services account for your current region.default ListWorkflowsPublisher
listWorkflowsPaginator
(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest) This is a variant oflistWorkflows(software.amazon.awssdk.services.transfer.model.ListWorkflowsRequest)
operation.default ListWorkflowsPublisher
listWorkflowsPaginator
(ListWorkflowsRequest listWorkflowsRequest) This is a variant oflistWorkflows(software.amazon.awssdk.services.transfer.model.ListWorkflowsRequest)
operation.sendWorkflowStepState
(Consumer<SendWorkflowStepStateRequest.Builder> sendWorkflowStepStateRequest) Sends a callback for asynchronous custom steps.sendWorkflowStepState
(SendWorkflowStepStateRequest sendWorkflowStepStateRequest) Sends a callback for asynchronous custom steps.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartFileTransfer
(Consumer<StartFileTransferRequest.Builder> startFileTransferRequest) Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.startFileTransfer
(StartFileTransferRequest startFileTransferRequest) Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.default CompletableFuture
<StartServerResponse> startServer
(Consumer<StartServerRequest.Builder> startServerRequest) Changes the state of a file transfer protocol-enabled server fromOFFLINE
toONLINE
.default CompletableFuture
<StartServerResponse> startServer
(StartServerRequest startServerRequest) Changes the state of a file transfer protocol-enabled server fromOFFLINE
toONLINE
.default CompletableFuture
<StopServerResponse> stopServer
(Consumer<StopServerRequest.Builder> stopServerRequest) Changes the state of a file transfer protocol-enabled server fromONLINE
toOFFLINE
.default CompletableFuture
<StopServerResponse> stopServer
(StopServerRequest stopServerRequest) Changes the state of a file transfer protocol-enabled server fromONLINE
toOFFLINE
.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).default CompletableFuture
<TestConnectionResponse> testConnection
(Consumer<TestConnectionRequest.Builder> testConnectionRequest) Tests whether your SFTP connector is set up successfully.default CompletableFuture
<TestConnectionResponse> testConnection
(TestConnectionRequest testConnectionRequest) Tests whether your SFTP connector is set up successfully.testIdentityProvider
(Consumer<TestIdentityProviderRequest.Builder> testIdentityProviderRequest) If theIdentityProviderType
of a file transfer protocol-enabled server isAWS_DIRECTORY_SERVICE
orAPI_Gateway
, tests whether your identity provider is set up successfully.testIdentityProvider
(TestIdentityProviderRequest testIdentityProviderRequest) If theIdentityProviderType
of a file transfer protocol-enabled server isAWS_DIRECTORY_SERVICE
orAPI_Gateway
, tests whether your identity provider is set up successfully.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).default CompletableFuture
<UpdateAccessResponse> updateAccess
(Consumer<UpdateAccessRequest.Builder> updateAccessRequest) Allows you to update parameters for the access specified in theServerID
andExternalID
parameters.default CompletableFuture
<UpdateAccessResponse> updateAccess
(UpdateAccessRequest updateAccessRequest) Allows you to update parameters for the access specified in theServerID
andExternalID
parameters.default CompletableFuture
<UpdateAgreementResponse> updateAgreement
(Consumer<UpdateAgreementRequest.Builder> updateAgreementRequest) Updates some of the parameters for an existing agreement.default CompletableFuture
<UpdateAgreementResponse> updateAgreement
(UpdateAgreementRequest updateAgreementRequest) Updates some of the parameters for an existing agreement.updateCertificate
(Consumer<UpdateCertificateRequest.Builder> updateCertificateRequest) Updates the active and inactive dates for a certificate.updateCertificate
(UpdateCertificateRequest updateCertificateRequest) Updates the active and inactive dates for a certificate.default CompletableFuture
<UpdateConnectorResponse> updateConnector
(Consumer<UpdateConnectorRequest.Builder> updateConnectorRequest) Updates some of the parameters for an existing connector.default CompletableFuture
<UpdateConnectorResponse> updateConnector
(UpdateConnectorRequest updateConnectorRequest) Updates some of the parameters for an existing connector.default CompletableFuture
<UpdateHostKeyResponse> updateHostKey
(Consumer<UpdateHostKeyRequest.Builder> updateHostKeyRequest) Updates the description for the host key that's specified by theServerId
andHostKeyId
parameters.default CompletableFuture
<UpdateHostKeyResponse> updateHostKey
(UpdateHostKeyRequest updateHostKeyRequest) Updates the description for the host key that's specified by theServerId
andHostKeyId
parameters.default CompletableFuture
<UpdateProfileResponse> updateProfile
(Consumer<UpdateProfileRequest.Builder> updateProfileRequest) Updates some of the parameters for an existing profile.default CompletableFuture
<UpdateProfileResponse> updateProfile
(UpdateProfileRequest updateProfileRequest) Updates some of the parameters for an existing profile.default CompletableFuture
<UpdateServerResponse> updateServer
(Consumer<UpdateServerRequest.Builder> updateServerRequest) Updates the file transfer protocol-enabled server's properties after that server has been created.default CompletableFuture
<UpdateServerResponse> updateServer
(UpdateServerRequest updateServerRequest) Updates the file transfer protocol-enabled server's properties after that server has been created.default CompletableFuture
<UpdateUserResponse> updateUser
(Consumer<UpdateUserRequest.Builder> updateUserRequest) Assigns new properties to a user.default CompletableFuture
<UpdateUserResponse> updateUser
(UpdateUserRequest updateUserRequest) Assigns new properties to a user.default TransferAsyncWaiter
waiter()
Create an instance ofTransferAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createAccess
default CompletableFuture<CreateAccessResponse> 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.- Parameters:
createAccessRequest
-- Returns:
- A Java Future containing the result of the CreateAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAccess
default CompletableFuture<CreateAccessResponse> createAccess(Consumer<CreateAccessRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateAccessRequest.Builder
avoiding the need to create one manually viaCreateAccessRequest.builder()
- Parameters:
createAccessRequest
- AConsumer
that will call methods onCreateAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAgreement
default CompletableFuture<CreateAgreementResponse> 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 theLocalProfileId
.- Parameters:
createAgreementRequest
-- Returns:
- A Java Future containing the result of the CreateAgreement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAgreement
default CompletableFuture<CreateAgreementResponse> createAgreement(Consumer<CreateAgreementRequest.Builder> 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 theLocalProfileId
.
This is a convenience which creates an instance of the
CreateAgreementRequest.Builder
avoiding the need to create one manually viaCreateAgreementRequest.builder()
- Parameters:
createAgreementRequest
- AConsumer
that will call methods onCreateAgreementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAgreement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createConnector
default CompletableFuture<CreateConnectorResponse> 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
).- Parameters:
createConnectorRequest
-- Returns:
- A Java Future containing the result of the CreateConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createConnector
default CompletableFuture<CreateConnectorResponse> createConnector(Consumer<CreateConnectorRequest.Builder> 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
).
This is a convenience which creates an instance of the
CreateConnectorRequest.Builder
avoiding the need to create one manually viaCreateConnectorRequest.builder()
- Parameters:
createConnectorRequest
- AConsumer
that will call methods onCreateConnectorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProfile
default CompletableFuture<CreateProfileResponse> createProfile(CreateProfileRequest createProfileRequest) Creates the local or partner profile to use for AS2 transfers.
- Parameters:
createProfileRequest
-- Returns:
- A Java Future containing the result of the CreateProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProfile
default CompletableFuture<CreateProfileResponse> createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest) Creates the local or partner profile to use for AS2 transfers.
This is a convenience which creates an instance of the
CreateProfileRequest.Builder
avoiding the need to create one manually viaCreateProfileRequest.builder()
- Parameters:
createProfileRequest
- AConsumer
that will call methods onCreateProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createServer
default CompletableFuture<CreateServerResponse> 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.- Parameters:
createServerRequest
-- Returns:
- A Java Future containing the result of the CreateServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createServer
default CompletableFuture<CreateServerResponse> createServer(Consumer<CreateServerRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateServerRequest.Builder
avoiding the need to create one manually viaCreateServerRequest.builder()
- Parameters:
createServerRequest
- AConsumer
that will call methods onCreateServerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createUser
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 toSERVICE_MANAGED
. Using parameters forCreateUser
, 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.- Parameters:
createUserRequest
-- Returns:
- A Java Future containing the result of the CreateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createUser
default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> 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 toSERVICE_MANAGED
. Using parameters forCreateUser
, 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.
This is a convenience which creates an instance of the
CreateUserRequest.Builder
avoiding the need to create one manually viaCreateUserRequest.builder()
- Parameters:
createUserRequest
- AConsumer
that will call methods onCreateUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createWorkflow
default CompletableFuture<CreateWorkflowResponse> 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 inCreateServer
andUpdateServer
operations.- Parameters:
createWorkflowRequest
-- Returns:
- A Java Future containing the result of the CreateWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createWorkflow
default CompletableFuture<CreateWorkflowResponse> createWorkflow(Consumer<CreateWorkflowRequest.Builder> 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 inCreateServer
andUpdateServer
operations.
This is a convenience which creates an instance of the
CreateWorkflowRequest.Builder
avoiding the need to create one manually viaCreateWorkflowRequest.builder()
- Parameters:
createWorkflowRequest
- AConsumer
that will call methods onCreateWorkflowRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAccess
default CompletableFuture<DeleteAccessResponse> deleteAccess(DeleteAccessRequest deleteAccessRequest) Allows you to delete the access specified in the
ServerID
andExternalID
parameters.- Parameters:
deleteAccessRequest
-- Returns:
- A Java Future containing the result of the DeleteAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAccess
default CompletableFuture<DeleteAccessResponse> deleteAccess(Consumer<DeleteAccessRequest.Builder> deleteAccessRequest) Allows you to delete the access specified in the
ServerID
andExternalID
parameters.
This is a convenience which creates an instance of the
DeleteAccessRequest.Builder
avoiding the need to create one manually viaDeleteAccessRequest.builder()
- Parameters:
deleteAccessRequest
- AConsumer
that will call methods onDeleteAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAgreement
default CompletableFuture<DeleteAgreementResponse> deleteAgreement(DeleteAgreementRequest deleteAgreementRequest) Delete the agreement that's specified in the provided
AgreementId
.- Parameters:
deleteAgreementRequest
-- Returns:
- A Java Future containing the result of the DeleteAgreement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAgreement
default CompletableFuture<DeleteAgreementResponse> deleteAgreement(Consumer<DeleteAgreementRequest.Builder> deleteAgreementRequest) Delete the agreement that's specified in the provided
AgreementId
.
This is a convenience which creates an instance of the
DeleteAgreementRequest.Builder
avoiding the need to create one manually viaDeleteAgreementRequest.builder()
- Parameters:
deleteAgreementRequest
- AConsumer
that will call methods onDeleteAgreementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAgreement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCertificate
default CompletableFuture<DeleteCertificateResponse> deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) Deletes the certificate that's specified in the
CertificateId
parameter.- Parameters:
deleteCertificateRequest
-- Returns:
- A Java Future containing the result of the DeleteCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCertificate
default CompletableFuture<DeleteCertificateResponse> deleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest) Deletes the certificate that's specified in the
CertificateId
parameter.
This is a convenience which creates an instance of the
DeleteCertificateRequest.Builder
avoiding the need to create one manually viaDeleteCertificateRequest.builder()
- Parameters:
deleteCertificateRequest
- AConsumer
that will call methods onDeleteCertificateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConnector
default CompletableFuture<DeleteConnectorResponse> deleteConnector(DeleteConnectorRequest deleteConnectorRequest) Deletes the connector that's specified in the provided
ConnectorId
.- Parameters:
deleteConnectorRequest
-- Returns:
- A Java Future containing the result of the DeleteConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConnector
default CompletableFuture<DeleteConnectorResponse> deleteConnector(Consumer<DeleteConnectorRequest.Builder> deleteConnectorRequest) Deletes the connector that's specified in the provided
ConnectorId
.
This is a convenience which creates an instance of the
DeleteConnectorRequest.Builder
avoiding the need to create one manually viaDeleteConnectorRequest.builder()
- Parameters:
deleteConnectorRequest
- AConsumer
that will call methods onDeleteConnectorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteHostKey
default CompletableFuture<DeleteHostKeyResponse> deleteHostKey(DeleteHostKeyRequest deleteHostKeyRequest) Deletes the host key that's specified in the
HostKeyId
parameter.- Parameters:
deleteHostKeyRequest
-- Returns:
- A Java Future containing the result of the DeleteHostKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteHostKey
default CompletableFuture<DeleteHostKeyResponse> deleteHostKey(Consumer<DeleteHostKeyRequest.Builder> deleteHostKeyRequest) Deletes the host key that's specified in the
HostKeyId
parameter.
This is a convenience which creates an instance of the
DeleteHostKeyRequest.Builder
avoiding the need to create one manually viaDeleteHostKeyRequest.builder()
- Parameters:
deleteHostKeyRequest
- AConsumer
that will call methods onDeleteHostKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteHostKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProfile
default CompletableFuture<DeleteProfileResponse> deleteProfile(DeleteProfileRequest deleteProfileRequest) Deletes the profile that's specified in the
ProfileId
parameter.- Parameters:
deleteProfileRequest
-- Returns:
- A Java Future containing the result of the DeleteProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProfile
default CompletableFuture<DeleteProfileResponse> deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest) Deletes the profile that's specified in the
ProfileId
parameter.
This is a convenience which creates an instance of the
DeleteProfileRequest.Builder
avoiding the need to create one manually viaDeleteProfileRequest.builder()
- Parameters:
deleteProfileRequest
- AConsumer
that will call methods onDeleteProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteServer
default CompletableFuture<DeleteServerResponse> deleteServer(DeleteServerRequest deleteServerRequest) Deletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.
- Parameters:
deleteServerRequest
-- Returns:
- A Java Future containing the result of the DeleteServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteServer
default CompletableFuture<DeleteServerResponse> deleteServer(Consumer<DeleteServerRequest.Builder> deleteServerRequest) Deletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.
This is a convenience which creates an instance of the
DeleteServerRequest.Builder
avoiding the need to create one manually viaDeleteServerRequest.builder()
- Parameters:
deleteServerRequest
- AConsumer
that will call methods onDeleteServerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSshPublicKey
default CompletableFuture<DeleteSshPublicKeyResponse> deleteSshPublicKey(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest) Deletes a user's Secure Shell (SSH) public key.
- Parameters:
deleteSshPublicKeyRequest
-- Returns:
- A Java Future containing the result of the DeleteSshPublicKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSshPublicKey
default CompletableFuture<DeleteSshPublicKeyResponse> deleteSshPublicKey(Consumer<DeleteSshPublicKeyRequest.Builder> deleteSshPublicKeyRequest) Deletes a user's Secure Shell (SSH) public key.
This is a convenience which creates an instance of the
DeleteSshPublicKeyRequest.Builder
avoiding the need to create one manually viaDeleteSshPublicKeyRequest.builder()
- Parameters:
deleteSshPublicKeyRequest
- AConsumer
that will call methods onDeleteSshPublicKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSshPublicKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUser
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.
- Parameters:
deleteUserRequest
-- Returns:
- A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUser
default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteUserRequest.Builder
avoiding the need to create one manually viaDeleteUserRequest.builder()
- Parameters:
deleteUserRequest
- AConsumer
that will call methods onDeleteUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteWorkflow
default CompletableFuture<DeleteWorkflowResponse> deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest) Deletes the specified workflow.
- Parameters:
deleteWorkflowRequest
-- Returns:
- A Java Future containing the result of the DeleteWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteWorkflow
default CompletableFuture<DeleteWorkflowResponse> deleteWorkflow(Consumer<DeleteWorkflowRequest.Builder> deleteWorkflowRequest) Deletes the specified workflow.
This is a convenience which creates an instance of the
DeleteWorkflowRequest.Builder
avoiding the need to create one manually viaDeleteWorkflowRequest.builder()
- Parameters:
deleteWorkflowRequest
- AConsumer
that will call methods onDeleteWorkflowRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccess
default CompletableFuture<DescribeAccessResponse> describeAccess(DescribeAccessRequest describeAccessRequest) Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId
property and itsExternalId
.The response from this call returns the properties of the access that is associated with the
ServerId
value that was specified.- Parameters:
describeAccessRequest
-- Returns:
- A Java Future containing the result of the DescribeAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccess
default CompletableFuture<DescribeAccessResponse> describeAccess(Consumer<DescribeAccessRequest.Builder> describeAccessRequest) Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId
property and itsExternalId
.The response from this call returns the properties of the access that is associated with the
ServerId
value that was specified.
This is a convenience which creates an instance of the
DescribeAccessRequest.Builder
avoiding the need to create one manually viaDescribeAccessRequest.builder()
- Parameters:
describeAccessRequest
- AConsumer
that will call methods onDescribeAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAgreement
default CompletableFuture<DescribeAgreementResponse> describeAgreement(DescribeAgreementRequest describeAgreementRequest) Describes the agreement that's identified by the
AgreementId
.- Parameters:
describeAgreementRequest
-- Returns:
- A Java Future containing the result of the DescribeAgreement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAgreement
default CompletableFuture<DescribeAgreementResponse> describeAgreement(Consumer<DescribeAgreementRequest.Builder> describeAgreementRequest) Describes the agreement that's identified by the
AgreementId
.
This is a convenience which creates an instance of the
DescribeAgreementRequest.Builder
avoiding the need to create one manually viaDescribeAgreementRequest.builder()
- Parameters:
describeAgreementRequest
- AConsumer
that will call methods onDescribeAgreementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAgreement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCertificate
default CompletableFuture<DescribeCertificateResponse> describeCertificate(DescribeCertificateRequest describeCertificateRequest) Describes the certificate that's identified by the
CertificateId
.- Parameters:
describeCertificateRequest
-- Returns:
- A Java Future containing the result of the DescribeCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCertificate
default CompletableFuture<DescribeCertificateResponse> describeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest) Describes the certificate that's identified by the
CertificateId
.
This is a convenience which creates an instance of the
DescribeCertificateRequest.Builder
avoiding the need to create one manually viaDescribeCertificateRequest.builder()
- Parameters:
describeCertificateRequest
- AConsumer
that will call methods onDescribeCertificateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConnector
default CompletableFuture<DescribeConnectorResponse> describeConnector(DescribeConnectorRequest describeConnectorRequest) Describes the connector that's identified by the
ConnectorId.
- Parameters:
describeConnectorRequest
-- Returns:
- A Java Future containing the result of the DescribeConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConnector
default CompletableFuture<DescribeConnectorResponse> describeConnector(Consumer<DescribeConnectorRequest.Builder> describeConnectorRequest) Describes the connector that's identified by the
ConnectorId.
This is a convenience which creates an instance of the
DescribeConnectorRequest.Builder
avoiding the need to create one manually viaDescribeConnectorRequest.builder()
- Parameters:
describeConnectorRequest
- AConsumer
that will call methods onDescribeConnectorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeExecution
default CompletableFuture<DescribeExecutionResponse> 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.- Parameters:
describeExecutionRequest
-- Returns:
- A Java Future containing the result of the DescribeExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeExecution
default CompletableFuture<DescribeExecutionResponse> describeExecution(Consumer<DescribeExecutionRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeExecutionRequest.Builder
avoiding the need to create one manually viaDescribeExecutionRequest.builder()
- Parameters:
describeExecutionRequest
- AConsumer
that will call methods onDescribeExecutionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeHostKey
default CompletableFuture<DescribeHostKeyResponse> describeHostKey(DescribeHostKeyRequest describeHostKeyRequest) Returns the details of the host key that's specified by the
HostKeyId
andServerId
.- Parameters:
describeHostKeyRequest
-- Returns:
- A Java Future containing the result of the DescribeHostKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeHostKey
default CompletableFuture<DescribeHostKeyResponse> describeHostKey(Consumer<DescribeHostKeyRequest.Builder> describeHostKeyRequest) Returns the details of the host key that's specified by the
HostKeyId
andServerId
.
This is a convenience which creates an instance of the
DescribeHostKeyRequest.Builder
avoiding the need to create one manually viaDescribeHostKeyRequest.builder()
- Parameters:
describeHostKeyRequest
- AConsumer
that will call methods onDescribeHostKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeHostKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeProfile
default CompletableFuture<DescribeProfileResponse> describeProfile(DescribeProfileRequest describeProfileRequest) Returns the details of the profile that's specified by the
ProfileId
.- Parameters:
describeProfileRequest
-- Returns:
- A Java Future containing the result of the DescribeProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeProfile
default CompletableFuture<DescribeProfileResponse> describeProfile(Consumer<DescribeProfileRequest.Builder> describeProfileRequest) Returns the details of the profile that's specified by the
ProfileId
.
This is a convenience which creates an instance of the
DescribeProfileRequest.Builder
avoiding the need to create one manually viaDescribeProfileRequest.builder()
- Parameters:
describeProfileRequest
- AConsumer
that will call methods onDescribeProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSecurityPolicy
default CompletableFuture<DescribeSecurityPolicyResponse> describeSecurityPolicy(DescribeSecurityPolicyRequest describeSecurityPolicyRequest) 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.
- Parameters:
describeSecurityPolicyRequest
-- Returns:
- A Java Future containing the result of the DescribeSecurityPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSecurityPolicy
default CompletableFuture<DescribeSecurityPolicyResponse> describeSecurityPolicy(Consumer<DescribeSecurityPolicyRequest.Builder> describeSecurityPolicyRequest) Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies.
This is a convenience which creates an instance of the
DescribeSecurityPolicyRequest.Builder
avoiding the need to create one manually viaDescribeSecurityPolicyRequest.builder()
- Parameters:
describeSecurityPolicyRequest
- AConsumer
that will call methods onDescribeSecurityPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeSecurityPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeServer
default CompletableFuture<DescribeServerResponse> 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 theEndpointDetails
.- Parameters:
describeServerRequest
-- Returns:
- A Java Future containing the result of the DescribeServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeServer
default CompletableFuture<DescribeServerResponse> describeServer(Consumer<DescribeServerRequest.Builder> 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 theEndpointDetails
.
This is a convenience which creates an instance of the
DescribeServerRequest.Builder
avoiding the need to create one manually viaDescribeServerRequest.builder()
- Parameters:
describeServerRequest
- AConsumer
that will call methods onDescribeServerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeUser
default CompletableFuture<DescribeUserResponse> 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.- Parameters:
describeUserRequest
-- Returns:
- A Java Future containing the result of the DescribeUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeUser
default CompletableFuture<DescribeUserResponse> describeUser(Consumer<DescribeUserRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeUserRequest.Builder
avoiding the need to create one manually viaDescribeUserRequest.builder()
- Parameters:
describeUserRequest
- AConsumer
that will call methods onDescribeUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeWorkflow
default CompletableFuture<DescribeWorkflowResponse> describeWorkflow(DescribeWorkflowRequest describeWorkflowRequest) Describes the specified workflow.
- Parameters:
describeWorkflowRequest
-- Returns:
- A Java Future containing the result of the DescribeWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeWorkflow
default CompletableFuture<DescribeWorkflowResponse> describeWorkflow(Consumer<DescribeWorkflowRequest.Builder> describeWorkflowRequest) Describes the specified workflow.
This is a convenience which creates an instance of the
DescribeWorkflowRequest.Builder
avoiding the need to create one manually viaDescribeWorkflowRequest.builder()
- Parameters:
describeWorkflowRequest
- AConsumer
that will call methods onDescribeWorkflowRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importCertificate
default CompletableFuture<ImportCertificateResponse> importCertificate(ImportCertificateRequest importCertificateRequest) Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.
- Parameters:
importCertificateRequest
-- Returns:
- A Java Future containing the result of the ImportCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importCertificate
default CompletableFuture<ImportCertificateResponse> importCertificate(Consumer<ImportCertificateRequest.Builder> importCertificateRequest) Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.
This is a convenience which creates an instance of the
ImportCertificateRequest.Builder
avoiding the need to create one manually viaImportCertificateRequest.builder()
- Parameters:
importCertificateRequest
- AConsumer
that will call methods onImportCertificateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ImportCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importHostKey
default CompletableFuture<ImportHostKeyResponse> importHostKey(ImportHostKeyRequest importHostKeyRequest) Adds a host key to the server that's specified by the
ServerId
parameter.- Parameters:
importHostKeyRequest
-- Returns:
- A Java Future containing the result of the ImportHostKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importHostKey
default CompletableFuture<ImportHostKeyResponse> importHostKey(Consumer<ImportHostKeyRequest.Builder> importHostKeyRequest) Adds a host key to the server that's specified by the
ServerId
parameter.
This is a convenience which creates an instance of the
ImportHostKeyRequest.Builder
avoiding the need to create one manually viaImportHostKeyRequest.builder()
- Parameters:
importHostKeyRequest
- AConsumer
that will call methods onImportHostKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ImportHostKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importSshPublicKey
default CompletableFuture<ImportSshPublicKeyResponse> 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 byServerId
.The response returns the
UserName
value, theServerId
value, and the name of theSshPublicKeyId
.- Parameters:
importSshPublicKeyRequest
-- Returns:
- A Java Future containing the result of the ImportSshPublicKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importSshPublicKey
default CompletableFuture<ImportSshPublicKeyResponse> importSshPublicKey(Consumer<ImportSshPublicKeyRequest.Builder> 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 byServerId
.The response returns the
UserName
value, theServerId
value, and the name of theSshPublicKeyId
.
This is a convenience which creates an instance of the
ImportSshPublicKeyRequest.Builder
avoiding the need to create one manually viaImportSshPublicKeyRequest.builder()
- Parameters:
importSshPublicKeyRequest
- AConsumer
that will call methods onImportSshPublicKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ImportSshPublicKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccesses
default CompletableFuture<ListAccessesResponse> listAccesses(ListAccessesRequest listAccessesRequest) Lists the details for all the accesses you have on your server.
- Parameters:
listAccessesRequest
-- Returns:
- A Java Future containing the result of the ListAccesses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccesses
default CompletableFuture<ListAccessesResponse> listAccesses(Consumer<ListAccessesRequest.Builder> listAccessesRequest) Lists the details for all the accesses you have on your server.
This is a convenience which creates an instance of the
ListAccessesRequest.Builder
avoiding the need to create one manually viaListAccessesRequest.builder()
- Parameters:
listAccessesRequest
- AConsumer
that will call methods onListAccessesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAccesses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessesPaginator
This is a variant of
listAccesses(software.amazon.awssdk.services.transfer.model.ListAccessesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListAccessesPublisher publisher = client.listAccessesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListAccessesPublisher publisher = client.listAccessesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListAccessesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListAccessesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccesses(software.amazon.awssdk.services.transfer.model.ListAccessesRequest)
operation.- Parameters:
listAccessesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessesPaginator
default ListAccessesPublisher listAccessesPaginator(Consumer<ListAccessesRequest.Builder> listAccessesRequest) This is a variant of
listAccesses(software.amazon.awssdk.services.transfer.model.ListAccessesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListAccessesPublisher publisher = client.listAccessesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListAccessesPublisher publisher = client.listAccessesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListAccessesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListAccessesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccesses(software.amazon.awssdk.services.transfer.model.ListAccessesRequest)
operation.
This is a convenience which creates an instance of the
ListAccessesRequest.Builder
avoiding the need to create one manually viaListAccessesRequest.builder()
- Parameters:
listAccessesRequest
- AConsumer
that will call methods onListAccessesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAgreements
default CompletableFuture<ListAgreementsResponse> 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 theMaxResults
parameter. If you ran the command previously and received a value forNextToken
, you can supply that value to continue listing agreements from where you left off.- Parameters:
listAgreementsRequest
-- Returns:
- A Java Future containing the result of the ListAgreements operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAgreements
default CompletableFuture<ListAgreementsResponse> listAgreements(Consumer<ListAgreementsRequest.Builder> 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 theMaxResults
parameter. If you ran the command previously and received a value forNextToken
, you can supply that value to continue listing agreements from where you left off.
This is a convenience which creates an instance of the
ListAgreementsRequest.Builder
avoiding the need to create one manually viaListAgreementsRequest.builder()
- Parameters:
listAgreementsRequest
- AConsumer
that will call methods onListAgreementsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAgreements operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAgreementsPaginator
default ListAgreementsPublisher listAgreementsPaginator(ListAgreementsRequest listAgreementsRequest) This is a variant of
listAgreements(software.amazon.awssdk.services.transfer.model.ListAgreementsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListAgreementsPublisher publisher = client.listAgreementsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListAgreementsPublisher publisher = client.listAgreementsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListAgreementsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListAgreementsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAgreements(software.amazon.awssdk.services.transfer.model.ListAgreementsRequest)
operation.- Parameters:
listAgreementsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAgreementsPaginator
default ListAgreementsPublisher listAgreementsPaginator(Consumer<ListAgreementsRequest.Builder> listAgreementsRequest) This is a variant of
listAgreements(software.amazon.awssdk.services.transfer.model.ListAgreementsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListAgreementsPublisher publisher = client.listAgreementsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListAgreementsPublisher publisher = client.listAgreementsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListAgreementsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListAgreementsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAgreements(software.amazon.awssdk.services.transfer.model.ListAgreementsRequest)
operation.
This is a convenience which creates an instance of the
ListAgreementsRequest.Builder
avoiding the need to create one manually viaListAgreementsRequest.builder()
- Parameters:
listAgreementsRequest
- AConsumer
that will call methods onListAgreementsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCertificates
default CompletableFuture<ListCertificatesResponse> 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 theNextToken
parameter, you can supply that value to continue listing certificates from where you left off.- Parameters:
listCertificatesRequest
-- Returns:
- A Java Future containing the result of the ListCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCertificates
default CompletableFuture<ListCertificatesResponse> listCertificates(Consumer<ListCertificatesRequest.Builder> 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 theNextToken
parameter, you can supply that value to continue listing certificates from where you left off.
This is a convenience which creates an instance of the
ListCertificatesRequest.Builder
avoiding the need to create one manually viaListCertificatesRequest.builder()
- Parameters:
listCertificatesRequest
- AConsumer
that will call methods onListCertificatesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCertificatesPaginator
default ListCertificatesPublisher listCertificatesPaginator(ListCertificatesRequest listCertificatesRequest) This is a variant of
listCertificates(software.amazon.awssdk.services.transfer.model.ListCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListCertificatesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCertificates(software.amazon.awssdk.services.transfer.model.ListCertificatesRequest)
operation.- Parameters:
listCertificatesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCertificatesPaginator
default ListCertificatesPublisher listCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) This is a variant of
listCertificates(software.amazon.awssdk.services.transfer.model.ListCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListCertificatesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCertificates(software.amazon.awssdk.services.transfer.model.ListCertificatesRequest)
operation.
This is a convenience which creates an instance of the
ListCertificatesRequest.Builder
avoiding the need to create one manually viaListCertificatesRequest.builder()
- Parameters:
listCertificatesRequest
- AConsumer
that will call methods onListCertificatesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConnectors
default CompletableFuture<ListConnectorsResponse> listConnectors(ListConnectorsRequest listConnectorsRequest) Lists the connectors for the specified Region.
- Parameters:
listConnectorsRequest
-- Returns:
- A Java Future containing the result of the ListConnectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConnectors
default CompletableFuture<ListConnectorsResponse> listConnectors(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest) Lists the connectors for the specified Region.
This is a convenience which creates an instance of the
ListConnectorsRequest.Builder
avoiding the need to create one manually viaListConnectorsRequest.builder()
- Parameters:
listConnectorsRequest
- AConsumer
that will call methods onListConnectorsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListConnectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConnectorsPaginator
default ListConnectorsPublisher listConnectorsPaginator(ListConnectorsRequest listConnectorsRequest) This is a variant of
listConnectors(software.amazon.awssdk.services.transfer.model.ListConnectorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListConnectorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListConnectorsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listConnectors(software.amazon.awssdk.services.transfer.model.ListConnectorsRequest)
operation.- Parameters:
listConnectorsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConnectorsPaginator
default ListConnectorsPublisher listConnectorsPaginator(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest) This is a variant of
listConnectors(software.amazon.awssdk.services.transfer.model.ListConnectorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListConnectorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListConnectorsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listConnectors(software.amazon.awssdk.services.transfer.model.ListConnectorsRequest)
operation.
This is a convenience which creates an instance of the
ListConnectorsRequest.Builder
avoiding the need to create one manually viaListConnectorsRequest.builder()
- Parameters:
listConnectorsRequest
- AConsumer
that will call methods onListConnectorsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listExecutions
default CompletableFuture<ListExecutionsResponse> listExecutions(ListExecutionsRequest listExecutionsRequest) Lists all in-progress executions for the specified workflow.
If the specified workflow ID cannot be found,
ListExecutions
returns aResourceNotFound
exception.- Parameters:
listExecutionsRequest
-- Returns:
- A Java Future containing the result of the ListExecutions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listExecutions
default CompletableFuture<ListExecutionsResponse> listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest) Lists all in-progress executions for the specified workflow.
If the specified workflow ID cannot be found,
ListExecutions
returns aResourceNotFound
exception.
This is a convenience which creates an instance of the
ListExecutionsRequest.Builder
avoiding the need to create one manually viaListExecutionsRequest.builder()
- Parameters:
listExecutionsRequest
- AConsumer
that will call methods onListExecutionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListExecutions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listExecutionsPaginator
default ListExecutionsPublisher listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest) This is a variant of
listExecutions(software.amazon.awssdk.services.transfer.model.ListExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListExecutionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListExecutionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExecutions(software.amazon.awssdk.services.transfer.model.ListExecutionsRequest)
operation.- Parameters:
listExecutionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listExecutionsPaginator
default ListExecutionsPublisher listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest) This is a variant of
listExecutions(software.amazon.awssdk.services.transfer.model.ListExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListExecutionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListExecutionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExecutions(software.amazon.awssdk.services.transfer.model.ListExecutionsRequest)
operation.
This is a convenience which creates an instance of the
ListExecutionsRequest.Builder
avoiding the need to create one manually viaListExecutionsRequest.builder()
- Parameters:
listExecutionsRequest
- AConsumer
that will call methods onListExecutionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHostKeys
default CompletableFuture<ListHostKeysResponse> listHostKeys(ListHostKeysRequest listHostKeysRequest) Returns a list of host keys for the server that's specified by the
ServerId
parameter.- Parameters:
listHostKeysRequest
-- Returns:
- A Java Future containing the result of the ListHostKeys operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHostKeys
default CompletableFuture<ListHostKeysResponse> listHostKeys(Consumer<ListHostKeysRequest.Builder> listHostKeysRequest) Returns a list of host keys for the server that's specified by the
ServerId
parameter.
This is a convenience which creates an instance of the
ListHostKeysRequest.Builder
avoiding the need to create one manually viaListHostKeysRequest.builder()
- Parameters:
listHostKeysRequest
- AConsumer
that will call methods onListHostKeysRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListHostKeys operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProfiles
default CompletableFuture<ListProfilesResponse> 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 forNextToken
, you can supply that value to continue listing profiles from where you left off.- Parameters:
listProfilesRequest
-- Returns:
- A Java Future containing the result of the ListProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProfiles
default CompletableFuture<ListProfilesResponse> listProfiles(Consumer<ListProfilesRequest.Builder> 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 forNextToken
, you can supply that value to continue listing profiles from where you left off.
This is a convenience which creates an instance of the
ListProfilesRequest.Builder
avoiding the need to create one manually viaListProfilesRequest.builder()
- Parameters:
listProfilesRequest
- AConsumer
that will call methods onListProfilesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProfilesPaginator
This is a variant of
listProfiles(software.amazon.awssdk.services.transfer.model.ListProfilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListProfilesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProfiles(software.amazon.awssdk.services.transfer.model.ListProfilesRequest)
operation.- Parameters:
listProfilesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProfilesPaginator
default ListProfilesPublisher listProfilesPaginator(Consumer<ListProfilesRequest.Builder> listProfilesRequest) This is a variant of
listProfiles(software.amazon.awssdk.services.transfer.model.ListProfilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListProfilesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProfiles(software.amazon.awssdk.services.transfer.model.ListProfilesRequest)
operation.
This is a convenience which creates an instance of the
ListProfilesRequest.Builder
avoiding the need to create one manually viaListProfilesRequest.builder()
- Parameters:
listProfilesRequest
- AConsumer
that will call methods onListProfilesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSecurityPolicies
default CompletableFuture<ListSecurityPoliciesResponse> listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest) Lists the security policies that are attached to your file transfer protocol-enabled servers.
- Parameters:
listSecurityPoliciesRequest
-- Returns:
- A Java Future containing the result of the ListSecurityPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSecurityPolicies
default CompletableFuture<ListSecurityPoliciesResponse> listSecurityPolicies(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest) Lists the security policies that are attached to your file transfer protocol-enabled servers.
This is a convenience which creates an instance of the
ListSecurityPoliciesRequest.Builder
avoiding the need to create one manually viaListSecurityPoliciesRequest.builder()
- Parameters:
listSecurityPoliciesRequest
- AConsumer
that will call methods onListSecurityPoliciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSecurityPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSecurityPoliciesPaginator
default ListSecurityPoliciesPublisher listSecurityPoliciesPaginator(ListSecurityPoliciesRequest listSecurityPoliciesRequest) This is a variant of
listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesPublisher publisher = client.listSecurityPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesPublisher publisher = client.listSecurityPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest)
operation.- Parameters:
listSecurityPoliciesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSecurityPoliciesPaginator
default ListSecurityPoliciesPublisher listSecurityPoliciesPaginator(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest) This is a variant of
listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesPublisher publisher = client.listSecurityPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesPublisher publisher = client.listSecurityPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest)
operation.
This is a convenience which creates an instance of the
ListSecurityPoliciesRequest.Builder
avoiding the need to create one manually viaListSecurityPoliciesRequest.builder()
- Parameters:
listSecurityPoliciesRequest
- AConsumer
that will call methods onListSecurityPoliciesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServers
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
- Parameters:
listServersRequest
-- Returns:
- A Java Future containing the result of the ListServers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServers
default CompletableFuture<ListServersResponse> listServers(Consumer<ListServersRequest.Builder> listServersRequest) Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
This is a convenience which creates an instance of the
ListServersRequest.Builder
avoiding the need to create one manually viaListServersRequest.builder()
- Parameters:
listServersRequest
- AConsumer
that will call methods onListServersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListServers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServers
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
- Returns:
- A Java Future containing the result of the ListServers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServersPaginator
This is a variant of
listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListServersPublisher publisher = client.listServersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListServersPublisher publisher = client.listServersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListServersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListServersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServersPaginator
This is a variant of
listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListServersPublisher publisher = client.listServersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListServersPublisher publisher = client.listServersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListServersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListServersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest)
operation.- Parameters:
listServersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServersPaginator
default ListServersPublisher listServersPaginator(Consumer<ListServersRequest.Builder> listServersRequest) This is a variant of
listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListServersPublisher publisher = client.listServersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListServersPublisher publisher = client.listServersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListServersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListServersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest)
operation.
This is a convenience which creates an instance of the
ListServersRequest.Builder
avoiding the need to create one manually viaListServersRequest.builder()
- Parameters:
listServersRequest
- AConsumer
that will call methods onListServersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> 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.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> 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.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant of
listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListTagsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListTagsForResourceResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest)
operation.- Parameters:
listTagsForResourceRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant of
listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListTagsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListTagsForResourceResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsers
Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter.- Parameters:
listUsersRequest
-- Returns:
- A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsers
default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter.
This is a convenience which creates an instance of the
ListUsersRequest.Builder
avoiding the need to create one manually viaListUsersRequest.builder()
- Parameters:
listUsersRequest
- AConsumer
that will call methods onListUsersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsersPaginator
This is a variant of
listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListUsersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListUsersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest)
operation.- Parameters:
listUsersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsersPaginator
This is a variant of
listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListUsersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListUsersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest)
operation.
This is a convenience which creates an instance of the
ListUsersRequest.Builder
avoiding the need to create one manually viaListUsersRequest.builder()
- Parameters:
listUsersRequest
- AConsumer
that will call methods onListUsersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkflows
default CompletableFuture<ListWorkflowsResponse> listWorkflows(ListWorkflowsRequest listWorkflowsRequest) Lists all workflows associated with your Amazon Web Services account for your current region.
- Parameters:
listWorkflowsRequest
-- Returns:
- A Java Future containing the result of the ListWorkflows operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkflows
default CompletableFuture<ListWorkflowsResponse> listWorkflows(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest) Lists all workflows associated with your Amazon Web Services account for your current region.
This is a convenience which creates an instance of the
ListWorkflowsRequest.Builder
avoiding the need to create one manually viaListWorkflowsRequest.builder()
- Parameters:
listWorkflowsRequest
- AConsumer
that will call methods onListWorkflowsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListWorkflows operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkflowsPaginator
This is a variant of
listWorkflows(software.amazon.awssdk.services.transfer.model.ListWorkflowsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListWorkflowsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListWorkflowsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkflows(software.amazon.awssdk.services.transfer.model.ListWorkflowsRequest)
operation.- Parameters:
listWorkflowsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkflowsPaginator
default ListWorkflowsPublisher listWorkflowsPaginator(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest) This is a variant of
listWorkflows(software.amazon.awssdk.services.transfer.model.ListWorkflowsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transfer.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transfer.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListWorkflowsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transfer.model.ListWorkflowsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkflows(software.amazon.awssdk.services.transfer.model.ListWorkflowsRequest)
operation.
This is a convenience which creates an instance of the
ListWorkflowsRequest.Builder
avoiding the need to create one manually viaListWorkflowsRequest.builder()
- Parameters:
listWorkflowsRequest
- AConsumer
that will call methods onListWorkflowsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sendWorkflowStepState
default CompletableFuture<SendWorkflowStepStateResponse> sendWorkflowStepState(SendWorkflowStepStateRequest sendWorkflowStepStateRequest) Sends a callback for asynchronous custom steps.
The
ExecutionId
,WorkflowId
, andToken
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.- Parameters:
sendWorkflowStepStateRequest
-- Returns:
- A Java Future containing the result of the SendWorkflowStepState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sendWorkflowStepState
default CompletableFuture<SendWorkflowStepStateResponse> sendWorkflowStepState(Consumer<SendWorkflowStepStateRequest.Builder> sendWorkflowStepStateRequest) Sends a callback for asynchronous custom steps.
The
ExecutionId
,WorkflowId
, andToken
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.
This is a convenience which creates an instance of the
SendWorkflowStepStateRequest.Builder
avoiding the need to create one manually viaSendWorkflowStepStateRequest.builder()
- Parameters:
sendWorkflowStepStateRequest
- AConsumer
that will call methods onSendWorkflowStepStateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SendWorkflowStepState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startFileTransfer
default CompletableFuture<StartFileTransferResponse> 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 moreSendFilePaths
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 aLocalDirectoryPath
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 aRemoteDirectoryPath
to specify the destination folder.
-
- Parameters:
startFileTransferRequest
-- Returns:
- A Java Future containing the result of the StartFileTransfer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
startFileTransfer
default CompletableFuture<StartFileTransferResponse> startFileTransfer(Consumer<StartFileTransferRequest.Builder> 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 moreSendFilePaths
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 aLocalDirectoryPath
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 aRemoteDirectoryPath
to specify the destination folder.
-
This is a convenience which creates an instance of the
StartFileTransferRequest.Builder
avoiding the need to create one manually viaStartFileTransferRequest.builder()
- Parameters:
startFileTransferRequest
- AConsumer
that will call methods onStartFileTransferRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartFileTransfer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
startServer
Changes the state of a file transfer protocol-enabled server from
OFFLINE
toONLINE
. It has no impact on a server that is alreadyONLINE
. AnONLINE
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 ofSTART_FAILED
can indicate an error condition.No response is returned from this call.
- Parameters:
startServerRequest
-- Returns:
- A Java Future containing the result of the StartServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startServer
default CompletableFuture<StartServerResponse> startServer(Consumer<StartServerRequest.Builder> startServerRequest) Changes the state of a file transfer protocol-enabled server from
OFFLINE
toONLINE
. It has no impact on a server that is alreadyONLINE
. AnONLINE
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 ofSTART_FAILED
can indicate an error condition.No response is returned from this call.
This is a convenience which creates an instance of the
StartServerRequest.Builder
avoiding the need to create one manually viaStartServerRequest.builder()
- Parameters:
startServerRequest
- AConsumer
that will call methods onStartServerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopServer
Changes the state of a file transfer protocol-enabled server from
ONLINE
toOFFLINE
. AnOFFLINE
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 ofSTOP_FAILED
can indicate an error condition.No response is returned from this call.
- Parameters:
stopServerRequest
-- Returns:
- A Java Future containing the result of the StopServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopServer
default CompletableFuture<StopServerResponse> stopServer(Consumer<StopServerRequest.Builder> stopServerRequest) Changes the state of a file transfer protocol-enabled server from
ONLINE
toOFFLINE
. AnOFFLINE
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 ofSTOP_FAILED
can indicate an error condition.No response is returned from this call.
This is a convenience which creates an instance of the
StopServerRequest.Builder
avoiding the need to create one manually viaStopServerRequest.builder()
- Parameters:
stopServerRequest
- AConsumer
that will call methods onStopServerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
testConnection
default CompletableFuture<TestConnectionResponse> 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.
- Parameters:
testConnectionRequest
-- Returns:
- A Java Future containing the result of the TestConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
testConnection
default CompletableFuture<TestConnectionResponse> testConnection(Consumer<TestConnectionRequest.Builder> 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.
This is a convenience which creates an instance of the
TestConnectionRequest.Builder
avoiding the need to create one manually viaTestConnectionRequest.builder()
- Parameters:
testConnectionRequest
- AConsumer
that will call methods onTestConnectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TestConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
testIdentityProvider
default CompletableFuture<TestIdentityProviderResponse> testIdentityProvider(TestIdentityProviderRequest testIdentityProviderRequest) If the
IdentityProviderType
of a file transfer protocol-enabled server isAWS_DIRECTORY_SERVICE
orAPI_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
andUserName
parameters are required. TheServerProtocol
,SourceIp
, andUserPassword
are all optional.Note the following:
-
You cannot use
TestIdentityProvider
if theIdentityProviderType
of your server isSERVICE_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).
- Parameters:
testIdentityProviderRequest
-- Returns:
- A Java Future containing the result of the TestIdentityProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
testIdentityProvider
default CompletableFuture<TestIdentityProviderResponse> testIdentityProvider(Consumer<TestIdentityProviderRequest.Builder> testIdentityProviderRequest) If the
IdentityProviderType
of a file transfer protocol-enabled server isAWS_DIRECTORY_SERVICE
orAPI_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
andUserName
parameters are required. TheServerProtocol
,SourceIp
, andUserPassword
are all optional.Note the following:
-
You cannot use
TestIdentityProvider
if theIdentityProviderType
of your server isSERVICE_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).
This is a convenience which creates an instance of the
TestIdentityProviderRequest.Builder
avoiding the need to create one manually viaTestIdentityProviderRequest.builder()
- Parameters:
testIdentityProviderRequest
- AConsumer
that will call methods onTestIdentityProviderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TestIdentityProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
untagResource
default CompletableFuture<UntagResourceResponse> 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.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> 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.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAccess
default CompletableFuture<UpdateAccessResponse> updateAccess(UpdateAccessRequest updateAccessRequest) Allows you to update parameters for the access specified in the
ServerID
andExternalID
parameters.- Parameters:
updateAccessRequest
-- Returns:
- A Java Future containing the result of the UpdateAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAccess
default CompletableFuture<UpdateAccessResponse> updateAccess(Consumer<UpdateAccessRequest.Builder> updateAccessRequest) Allows you to update parameters for the access specified in the
ServerID
andExternalID
parameters.
This is a convenience which creates an instance of the
UpdateAccessRequest.Builder
avoiding the need to create one manually viaUpdateAccessRequest.builder()
- Parameters:
updateAccessRequest
- AConsumer
that will call methods onUpdateAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAgreement
default CompletableFuture<UpdateAgreementResponse> updateAgreement(UpdateAgreementRequest updateAgreementRequest) Updates some of the parameters for an existing agreement. Provide the
AgreementId
and theServerId
for the agreement that you want to update, along with the new values for the parameters to update.- Parameters:
updateAgreementRequest
-- Returns:
- A Java Future containing the result of the UpdateAgreement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAgreement
default CompletableFuture<UpdateAgreementResponse> updateAgreement(Consumer<UpdateAgreementRequest.Builder> updateAgreementRequest) Updates some of the parameters for an existing agreement. Provide the
AgreementId
and theServerId
for the agreement that you want to update, along with the new values for the parameters to update.
This is a convenience which creates an instance of the
UpdateAgreementRequest.Builder
avoiding the need to create one manually viaUpdateAgreementRequest.builder()
- Parameters:
updateAgreementRequest
- AConsumer
that will call methods onUpdateAgreementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAgreement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCertificate
default CompletableFuture<UpdateCertificateResponse> updateCertificate(UpdateCertificateRequest updateCertificateRequest) Updates the active and inactive dates for a certificate.
- Parameters:
updateCertificateRequest
-- Returns:
- A Java Future containing the result of the UpdateCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCertificate
default CompletableFuture<UpdateCertificateResponse> updateCertificate(Consumer<UpdateCertificateRequest.Builder> updateCertificateRequest) Updates the active and inactive dates for a certificate.
This is a convenience which creates an instance of the
UpdateCertificateRequest.Builder
avoiding the need to create one manually viaUpdateCertificateRequest.builder()
- Parameters:
updateCertificateRequest
- AConsumer
that will call methods onUpdateCertificateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateConnector
default CompletableFuture<UpdateConnectorResponse> 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.- Parameters:
updateConnectorRequest
-- Returns:
- A Java Future containing the result of the UpdateConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateConnector
default CompletableFuture<UpdateConnectorResponse> updateConnector(Consumer<UpdateConnectorRequest.Builder> 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.
This is a convenience which creates an instance of the
UpdateConnectorRequest.Builder
avoiding the need to create one manually viaUpdateConnectorRequest.builder()
- Parameters:
updateConnectorRequest
- AConsumer
that will call methods onUpdateConnectorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateHostKey
default CompletableFuture<UpdateHostKeyResponse> updateHostKey(UpdateHostKeyRequest updateHostKeyRequest) Updates the description for the host key that's specified by the
ServerId
andHostKeyId
parameters.- Parameters:
updateHostKeyRequest
-- Returns:
- A Java Future containing the result of the UpdateHostKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateHostKey
default CompletableFuture<UpdateHostKeyResponse> updateHostKey(Consumer<UpdateHostKeyRequest.Builder> updateHostKeyRequest) Updates the description for the host key that's specified by the
ServerId
andHostKeyId
parameters.
This is a convenience which creates an instance of the
UpdateHostKeyRequest.Builder
avoiding the need to create one manually viaUpdateHostKeyRequest.builder()
- Parameters:
updateHostKeyRequest
- AConsumer
that will call methods onUpdateHostKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateHostKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProfile
default CompletableFuture<UpdateProfileResponse> 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.- Parameters:
updateProfileRequest
-- Returns:
- A Java Future containing the result of the UpdateProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProfile
default CompletableFuture<UpdateProfileResponse> updateProfile(Consumer<UpdateProfileRequest.Builder> 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.
This is a convenience which creates an instance of the
UpdateProfileRequest.Builder
avoiding the need to create one manually viaUpdateProfileRequest.builder()
- Parameters:
updateProfileRequest
- AConsumer
that will call methods onUpdateProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateServer
default CompletableFuture<UpdateServerResponse> updateServer(UpdateServerRequest updateServerRequest) Updates the file transfer protocol-enabled server's properties after that server has been created.
The
UpdateServer
call returns theServerId
of the server you updated.- Parameters:
updateServerRequest
-- Returns:
- A Java Future containing the result of the UpdateServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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'sVpcEndpointID
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException This exception is thrown when the
- See Also:
-
updateServer
default CompletableFuture<UpdateServerResponse> updateServer(Consumer<UpdateServerRequest.Builder> updateServerRequest) Updates the file transfer protocol-enabled server's properties after that server has been created.
The
UpdateServer
call returns theServerId
of the server you updated.
This is a convenience which creates an instance of the
UpdateServerRequest.Builder
avoiding the need to create one manually viaUpdateServerRequest.builder()
- Parameters:
updateServerRequest
- AConsumer
that will call methods onUpdateServerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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'sVpcEndpointID
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException This exception is thrown when the
- See Also:
-
updateUser
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
andServerId
you specify.The response returns the
ServerId
and theUserName
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
toLOGICAL
, and specifyHomeDirectoryMappings
withEntry
as root (/
) andTarget
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\"}]"
- Parameters:
updateUserRequest
-- Returns:
- A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateUser
default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> 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
andServerId
you specify.The response returns the
ServerId
and theUserName
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
toLOGICAL
, and specifyHomeDirectoryMappings
withEntry
as root (/
) andTarget
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\"}]"
This is a convenience which creates an instance of the
UpdateUserRequest.Builder
avoiding the need to create one manually viaUpdateUserRequest.builder()
- Parameters:
updateUserRequest
- AConsumer
that will call methods onUpdateUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TransferException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
waiter
Create an instance ofTransferAsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
TransferAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aTransferAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aTransferAsyncClient
.
-