All Superinterfaces:: AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface TransferClient extends AwsClient

Service client for accessing AWS Transfer. This can be created using the static builder() method.

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 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

Fields

Modifier and Type

Field

Description

static final String

SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

static final String

SERVICE_NAME
Method Summary

Modifier and Type

Method

Description

static TransferClientBuilder

builder()

Create a builder that can be used to configure and create a TransferClient.

static TransferClient

create()

Create a TransferClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

default 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 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 CreateAgreementResponse

createAgreement(Consumer<CreateAgreementRequest.Builder> createAgreementRequest)

Creates an agreement.

default CreateAgreementResponse

createAgreement(CreateAgreementRequest createAgreementRequest)

Creates an agreement.

default CreateConnectorResponse

createConnector(Consumer<CreateConnectorRequest.Builder> createConnectorRequest)

Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.

default CreateConnectorResponse

createConnector(CreateConnectorRequest createConnectorRequest)

Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.

default CreateProfileResponse

createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest)

Creates the local or partner profile to use for AS2 transfers.

default CreateProfileResponse

createProfile(CreateProfileRequest createProfileRequest)

Creates the local or partner profile to use for AS2 transfers.

default CreateServerResponse

createServer(Consumer<CreateServerRequest.Builder> createServerRequest)

Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.

default CreateServerResponse

createServer(CreateServerRequest createServerRequest)

Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.

default CreateUserResponse

createUser(Consumer<CreateUserRequest.Builder> createUserRequest)

Creates a user and associates them with an existing file transfer protocol-enabled server.

default CreateUserResponse

createUser(CreateUserRequest createUserRequest)

Creates a user and associates them with an existing file transfer protocol-enabled server.

default 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 CreateWorkflowResponse

createWorkflow(CreateWorkflowRequest createWorkflowRequest)

Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.

default DeleteAccessResponse

deleteAccess(Consumer<DeleteAccessRequest.Builder> deleteAccessRequest)

Allows you to delete the access specified in the ServerID and ExternalID parameters.

default DeleteAccessResponse

deleteAccess(DeleteAccessRequest deleteAccessRequest)

Allows you to delete the access specified in the ServerID and ExternalID parameters.

default DeleteAgreementResponse

deleteAgreement(Consumer<DeleteAgreementRequest.Builder> deleteAgreementRequest)

Delete the agreement that's specified in the provided AgreementId.

default DeleteAgreementResponse

deleteAgreement(DeleteAgreementRequest deleteAgreementRequest)

Delete the agreement that's specified in the provided AgreementId.

default DeleteCertificateResponse

deleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest)

Deletes the certificate that's specified in the CertificateId parameter.

default DeleteCertificateResponse

deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)

Deletes the certificate that's specified in the CertificateId parameter.

default DeleteConnectorResponse

deleteConnector(Consumer<DeleteConnectorRequest.Builder> deleteConnectorRequest)

Deletes the connector that's specified in the provided ConnectorId.

default DeleteConnectorResponse

deleteConnector(DeleteConnectorRequest deleteConnectorRequest)

Deletes the connector that's specified in the provided ConnectorId.

default DeleteHostKeyResponse

deleteHostKey(Consumer<DeleteHostKeyRequest.Builder> deleteHostKeyRequest)

Deletes the host key that's specified in the HostKeyId parameter.

default DeleteHostKeyResponse

deleteHostKey(DeleteHostKeyRequest deleteHostKeyRequest)

Deletes the host key that's specified in the HostKeyId parameter.

default DeleteProfileResponse

deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest)

Deletes the profile that's specified in the ProfileId parameter.

default DeleteProfileResponse

deleteProfile(DeleteProfileRequest deleteProfileRequest)

Deletes the profile that's specified in the ProfileId parameter.

default DeleteServerResponse

deleteServer(Consumer<DeleteServerRequest.Builder> deleteServerRequest)

Deletes the file transfer protocol-enabled server that you specify.

default DeleteServerResponse

deleteServer(DeleteServerRequest deleteServerRequest)

Deletes the file transfer protocol-enabled server that you specify.

default DeleteSshPublicKeyResponse

deleteSshPublicKey(Consumer<DeleteSshPublicKeyRequest.Builder> deleteSshPublicKeyRequest)

Deletes a user's Secure Shell (SSH) public key.

default DeleteSshPublicKeyResponse

deleteSshPublicKey(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest)

Deletes a user's Secure Shell (SSH) public key.

default DeleteUserResponse

deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)

Deletes the user belonging to a file transfer protocol-enabled server you specify.

default DeleteUserResponse

deleteUser(DeleteUserRequest deleteUserRequest)

Deletes the user belonging to a file transfer protocol-enabled server you specify.

default DeleteWorkflowResponse

deleteWorkflow(Consumer<DeleteWorkflowRequest.Builder> deleteWorkflowRequest)

Deletes the specified workflow.

default DeleteWorkflowResponse

deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest)

Deletes the specified workflow.

default 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 its ExternalId.

default 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 its ExternalId.

default DescribeAgreementResponse

describeAgreement(Consumer<DescribeAgreementRequest.Builder> describeAgreementRequest)

Describes the agreement that's identified by the AgreementId.

default DescribeAgreementResponse

describeAgreement(DescribeAgreementRequest describeAgreementRequest)

Describes the agreement that's identified by the AgreementId.

default DescribeCertificateResponse

describeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest)

Describes the certificate that's identified by the CertificateId.

default DescribeCertificateResponse

describeCertificate(DescribeCertificateRequest describeCertificateRequest)

Describes the certificate that's identified by the CertificateId.

default DescribeConnectorResponse

describeConnector(Consumer<DescribeConnectorRequest.Builder> describeConnectorRequest)

Describes the connector that's identified by the ConnectorId.

default DescribeConnectorResponse

describeConnector(DescribeConnectorRequest describeConnectorRequest)

Describes the connector that's identified by the ConnectorId.

default DescribeExecutionResponse

describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest)

You can use DescribeExecution to check the details of the execution of the specified workflow.

default DescribeExecutionResponse

describeExecution(DescribeExecutionRequest describeExecutionRequest)

You can use DescribeExecution to check the details of the execution of the specified workflow.

default DescribeHostKeyResponse

describeHostKey(Consumer<DescribeHostKeyRequest.Builder> describeHostKeyRequest)

Returns the details of the host key that's specified by the HostKeyId and ServerId.

default DescribeHostKeyResponse

describeHostKey(DescribeHostKeyRequest describeHostKeyRequest)

Returns the details of the host key that's specified by the HostKeyId and ServerId.

default DescribeProfileResponse

describeProfile(Consumer<DescribeProfileRequest.Builder> describeProfileRequest)

Returns the details of the profile that's specified by the ProfileId.

default DescribeProfileResponse

describeProfile(DescribeProfileRequest describeProfileRequest)

Returns the details of the profile that's specified by the ProfileId.

default DescribeSecurityPolicyResponse

describeSecurityPolicy(Consumer<DescribeSecurityPolicyRequest.Builder> describeSecurityPolicyRequest)

Describes the security policy that is attached to your server or SFTP connector.

default DescribeSecurityPolicyResponse

describeSecurityPolicy(DescribeSecurityPolicyRequest describeSecurityPolicyRequest)

Describes the security policy that is attached to your server or SFTP connector.

default DescribeServerResponse

describeServer(Consumer<DescribeServerRequest.Builder> describeServerRequest)

Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

default DescribeServerResponse

describeServer(DescribeServerRequest describeServerRequest)

Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

default DescribeUserResponse

describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)

Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property.

default DescribeUserResponse

describeUser(DescribeUserRequest describeUserRequest)

Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property.

default DescribeWorkflowResponse

describeWorkflow(Consumer<DescribeWorkflowRequest.Builder> describeWorkflowRequest)

Describes the specified workflow.

default DescribeWorkflowResponse

describeWorkflow(DescribeWorkflowRequest describeWorkflowRequest)

Describes the specified workflow.

default ImportCertificateResponse

importCertificate(Consumer<ImportCertificateRequest.Builder> importCertificateRequest)

Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

default ImportCertificateResponse

importCertificate(ImportCertificateRequest importCertificateRequest)

Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

default ImportHostKeyResponse

importHostKey(Consumer<ImportHostKeyRequest.Builder> importHostKeyRequest)

Adds a host key to the server that's specified by the ServerId parameter.

default ImportHostKeyResponse

importHostKey(ImportHostKeyRequest importHostKeyRequest)

Adds a host key to the server that's specified by the ServerId parameter.

default 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 by ServerId.

default 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 by ServerId.

default ListAccessesResponse

listAccesses(Consumer<ListAccessesRequest.Builder> listAccessesRequest)

Lists the details for all the accesses you have on your server.

default ListAccessesResponse

listAccesses(ListAccessesRequest listAccessesRequest)

Lists the details for all the accesses you have on your server.

default ListAccessesIterable

listAccessesPaginator(Consumer<ListAccessesRequest.Builder> listAccessesRequest)

This is a variant of listAccesses(software.amazon.awssdk.services.transfer.model.ListAccessesRequest) operation.

default ListAccessesIterable

listAccessesPaginator(ListAccessesRequest listAccessesRequest)

This is a variant of listAccesses(software.amazon.awssdk.services.transfer.model.ListAccessesRequest) operation.

default ListAgreementsResponse

listAgreements(Consumer<ListAgreementsRequest.Builder> listAgreementsRequest)

Returns a list of the agreements for the server that's identified by the ServerId that you supply.

default ListAgreementsResponse

listAgreements(ListAgreementsRequest listAgreementsRequest)

Returns a list of the agreements for the server that's identified by the ServerId that you supply.

default ListAgreementsIterable

listAgreementsPaginator(Consumer<ListAgreementsRequest.Builder> listAgreementsRequest)

This is a variant of listAgreements(software.amazon.awssdk.services.transfer.model.ListAgreementsRequest) operation.

default ListAgreementsIterable

listAgreementsPaginator(ListAgreementsRequest listAgreementsRequest)

This is a variant of listAgreements(software.amazon.awssdk.services.transfer.model.ListAgreementsRequest) operation.

default ListCertificatesResponse

listCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)

Returns a list of the current certificates that have been imported into Transfer Family.

default ListCertificatesResponse

listCertificates(ListCertificatesRequest listCertificatesRequest)

Returns a list of the current certificates that have been imported into Transfer Family.

default ListCertificatesIterable

listCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)

This is a variant of listCertificates(software.amazon.awssdk.services.transfer.model.ListCertificatesRequest) operation.

default ListCertificatesIterable

listCertificatesPaginator(ListCertificatesRequest listCertificatesRequest)

This is a variant of listCertificates(software.amazon.awssdk.services.transfer.model.ListCertificatesRequest) operation.

default ListConnectorsResponse

listConnectors(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest)

Lists the connectors for the specified Region.

default ListConnectorsResponse

listConnectors(ListConnectorsRequest listConnectorsRequest)

Lists the connectors for the specified Region.

default ListConnectorsIterable

listConnectorsPaginator(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest)

This is a variant of listConnectors(software.amazon.awssdk.services.transfer.model.ListConnectorsRequest) operation.

default ListConnectorsIterable

listConnectorsPaginator(ListConnectorsRequest listConnectorsRequest)

This is a variant of listConnectors(software.amazon.awssdk.services.transfer.model.ListConnectorsRequest) operation.

default ListExecutionsResponse

listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)

Lists all in-progress executions for the specified workflow.

default ListExecutionsResponse

listExecutions(ListExecutionsRequest listExecutionsRequest)

Lists all in-progress executions for the specified workflow.

default ListExecutionsIterable

listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)

This is a variant of listExecutions(software.amazon.awssdk.services.transfer.model.ListExecutionsRequest) operation.

default ListExecutionsIterable

listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)

This is a variant of listExecutions(software.amazon.awssdk.services.transfer.model.ListExecutionsRequest) operation.

default ListFileTransferResultsResponse

listFileTransferResults(Consumer<ListFileTransferResultsRequest.Builder> listFileTransferResultsRequest)

Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation.

default ListFileTransferResultsResponse

listFileTransferResults(ListFileTransferResultsRequest listFileTransferResultsRequest)

Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation.

default ListFileTransferResultsIterable

listFileTransferResultsPaginator(Consumer<ListFileTransferResultsRequest.Builder> listFileTransferResultsRequest)

This is a variant of listFileTransferResults(software.amazon.awssdk.services.transfer.model.ListFileTransferResultsRequest) operation.

default ListFileTransferResultsIterable

listFileTransferResultsPaginator(ListFileTransferResultsRequest listFileTransferResultsRequest)

This is a variant of listFileTransferResults(software.amazon.awssdk.services.transfer.model.ListFileTransferResultsRequest) operation.

default ListHostKeysResponse

listHostKeys(Consumer<ListHostKeysRequest.Builder> listHostKeysRequest)

Returns a list of host keys for the server that's specified by the ServerId parameter.

default ListHostKeysResponse

listHostKeys(ListHostKeysRequest listHostKeysRequest)

Returns a list of host keys for the server that's specified by the ServerId parameter.

default ListProfilesResponse

listProfiles(Consumer<ListProfilesRequest.Builder> listProfilesRequest)

Returns a list of the profiles for your system.

default ListProfilesResponse

listProfiles(ListProfilesRequest listProfilesRequest)

Returns a list of the profiles for your system.

default ListProfilesIterable

listProfilesPaginator(Consumer<ListProfilesRequest.Builder> listProfilesRequest)

This is a variant of listProfiles(software.amazon.awssdk.services.transfer.model.ListProfilesRequest) operation.

default ListProfilesIterable

listProfilesPaginator(ListProfilesRequest listProfilesRequest)

This is a variant of listProfiles(software.amazon.awssdk.services.transfer.model.ListProfilesRequest) operation.

default ListSecurityPoliciesResponse

listSecurityPolicies(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)

Lists the security policies that are attached to your servers and SFTP connectors.

default ListSecurityPoliciesResponse

listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest)

Lists the security policies that are attached to your servers and SFTP connectors.

default ListSecurityPoliciesIterable

listSecurityPoliciesPaginator(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)

This is a variant of listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest) operation.

default ListSecurityPoliciesIterable

listSecurityPoliciesPaginator(ListSecurityPoliciesRequest listSecurityPoliciesRequest)

This is a variant of listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest) operation.

default ListServersResponse

listServers()

Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.

default ListServersResponse

listServers(Consumer<ListServersRequest.Builder> listServersRequest)

Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.

default ListServersResponse

listServers(ListServersRequest listServersRequest)

Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.

default ListServersIterable

listServersPaginator()

This is a variant of listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest) operation.

default ListServersIterable

listServersPaginator(Consumer<ListServersRequest.Builder> listServersRequest)

This is a variant of listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest) operation.

default ListServersIterable

listServersPaginator(ListServersRequest listServersRequest)

This is a variant of listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest) operation.

default ListTagsForResourceResponse

listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.

default ListTagsForResourceResponse

listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.

default ListTagsForResourceIterable

listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

This is a variant of listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest) operation.

default ListTagsForResourceIterable

listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)

This is a variant of listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest) operation.

default ListUsersResponse

listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)

Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

default ListUsersResponse

listUsers(ListUsersRequest listUsersRequest)

Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

default ListUsersIterable

listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)

This is a variant of listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest) operation.

default ListUsersIterable

listUsersPaginator(ListUsersRequest listUsersRequest)

This is a variant of listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest) operation.

default ListWorkflowsResponse

listWorkflows(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest)

Lists all workflows associated with your Amazon Web Services account for your current region.

default ListWorkflowsResponse

listWorkflows(ListWorkflowsRequest listWorkflowsRequest)

Lists all workflows associated with your Amazon Web Services account for your current region.

default ListWorkflowsIterable

listWorkflowsPaginator(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest)

This is a variant of listWorkflows(software.amazon.awssdk.services.transfer.model.ListWorkflowsRequest) operation.

default ListWorkflowsIterable

listWorkflowsPaginator(ListWorkflowsRequest listWorkflowsRequest)

This is a variant of listWorkflows(software.amazon.awssdk.services.transfer.model.ListWorkflowsRequest) operation.

default SendWorkflowStepStateResponse

sendWorkflowStepState(Consumer<SendWorkflowStepStateRequest.Builder> sendWorkflowStepStateRequest)

Sends a callback for asynchronous custom steps.

default SendWorkflowStepStateResponse

sendWorkflowStepState(SendWorkflowStepStateRequest sendWorkflowStepStateRequest)

Sends a callback for asynchronous custom steps.

default TransferServiceClientConfiguration

serviceClientConfiguration()

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

static ServiceMetadata

serviceMetadata()

default StartDirectoryListingResponse

startDirectoryListing(Consumer<StartDirectoryListingRequest.Builder> startDirectoryListingRequest)

Retrieves a list of the contents of a directory from a remote SFTP server.

default StartDirectoryListingResponse

startDirectoryListing(StartDirectoryListingRequest startDirectoryListingRequest)

Retrieves a list of the contents of a directory from a remote SFTP server.

default StartFileTransferResponse

startFileTransfer(Consumer<StartFileTransferRequest.Builder> startFileTransferRequest)

Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.

default StartFileTransferResponse

startFileTransfer(StartFileTransferRequest startFileTransferRequest)

Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.

default StartServerResponse

startServer(Consumer<StartServerRequest.Builder> startServerRequest)

Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE.

default StartServerResponse

startServer(StartServerRequest startServerRequest)

Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE.

default StopServerResponse

stopServer(Consumer<StopServerRequest.Builder> stopServerRequest)

Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE.

default StopServerResponse

stopServer(StopServerRequest stopServerRequest)

Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE.

default TagResourceResponse

tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).

default TagResourceResponse

tagResource(TagResourceRequest tagResourceRequest)

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).

default TestConnectionResponse

testConnection(Consumer<TestConnectionRequest.Builder> testConnectionRequest)

Tests whether your SFTP connector is set up successfully.

default TestConnectionResponse

testConnection(TestConnectionRequest testConnectionRequest)

Tests whether your SFTP connector is set up successfully.

default TestIdentityProviderResponse

testIdentityProvider(Consumer<TestIdentityProviderRequest.Builder> testIdentityProviderRequest)

If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully.

default TestIdentityProviderResponse

testIdentityProvider(TestIdentityProviderRequest testIdentityProviderRequest)

If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully.

default UntagResourceResponse

untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).

default UntagResourceResponse

untagResource(UntagResourceRequest untagResourceRequest)

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).

default UpdateAccessResponse

updateAccess(Consumer<UpdateAccessRequest.Builder> updateAccessRequest)

Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.

default UpdateAccessResponse

updateAccess(UpdateAccessRequest updateAccessRequest)

Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.

default UpdateAgreementResponse

updateAgreement(Consumer<UpdateAgreementRequest.Builder> updateAgreementRequest)

Updates some of the parameters for an existing agreement.

default UpdateAgreementResponse

updateAgreement(UpdateAgreementRequest updateAgreementRequest)

Updates some of the parameters for an existing agreement.

default UpdateCertificateResponse

updateCertificate(Consumer<UpdateCertificateRequest.Builder> updateCertificateRequest)

Updates the active and inactive dates for a certificate.

default UpdateCertificateResponse

updateCertificate(UpdateCertificateRequest updateCertificateRequest)

Updates the active and inactive dates for a certificate.

default UpdateConnectorResponse

updateConnector(Consumer<UpdateConnectorRequest.Builder> updateConnectorRequest)

Updates some of the parameters for an existing connector.

default UpdateConnectorResponse

updateConnector(UpdateConnectorRequest updateConnectorRequest)

Updates some of the parameters for an existing connector.

default UpdateHostKeyResponse

updateHostKey(Consumer<UpdateHostKeyRequest.Builder> updateHostKeyRequest)

Updates the description for the host key that's specified by the ServerId and HostKeyId parameters.

default UpdateHostKeyResponse

updateHostKey(UpdateHostKeyRequest updateHostKeyRequest)

Updates the description for the host key that's specified by the ServerId and HostKeyId parameters.

default UpdateProfileResponse

updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest)

Updates some of the parameters for an existing profile.

default UpdateProfileResponse

updateProfile(UpdateProfileRequest updateProfileRequest)

Updates some of the parameters for an existing profile.

default UpdateServerResponse

updateServer(Consumer<UpdateServerRequest.Builder> updateServerRequest)

Updates the file transfer protocol-enabled server's properties after that server has been created.

default UpdateServerResponse

updateServer(UpdateServerRequest updateServerRequest)

Updates the file transfer protocol-enabled server's properties after that server has been created.

default UpdateUserResponse

updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)

Assigns new properties to a user.

default UpdateUserResponse

updateUser(UpdateUserRequest updateUserRequest)

Assigns new properties to a user.

default TransferWaiter

waiter()

Create an instance of TransferWaiter 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
  static final String SERVICE_NAME
  
  See Also:
  
  Constant Field Values
- SERVICE_METADATA_ID
  static final String SERVICE_METADATA_ID
  
  Value for looking up the service's metadata from the ServiceMetadataProvider.
  
  See Also:
  
  Constant Field Values
Method Details
- createAccess
  default CreateAccessResponse createAccess(CreateAccessRequest createAccessRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AwsServiceException, SdkClientException, TransferException
  
  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:
  
  Result of the CreateAccess operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createAccess
  default CreateAccessResponse createAccess(Consumer<CreateAccessRequest.Builder> createAccessRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AwsServiceException, SdkClientException, TransferException
  
  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 via CreateAccessRequest.builder()
  
  Parameters:
  
  createAccessRequest - A Consumer that will call methods on CreateAccessRequest.Builder to create a request.
  
  Returns:
  
  Result of the CreateAccess operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createAgreement
  default CreateAgreementResponse createAgreement(CreateAgreementRequest createAgreementRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AwsServiceException, SdkClientException, TransferException
  
  Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.
  
  The partner is identified with the PartnerProfileId, and the AS2 process is identified with the LocalProfileId.
  
  Parameters:
  
  createAgreementRequest -
  
  Returns:
  
  Result of the CreateAgreement operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createAgreement
  default CreateAgreementResponse createAgreement(Consumer<CreateAgreementRequest.Builder> createAgreementRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AwsServiceException, SdkClientException, TransferException
  
  Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.
  
  The partner is identified with the PartnerProfileId, and the AS2 process is identified with the LocalProfileId.
  
  This is a convenience which creates an instance of the CreateAgreementRequest.Builder avoiding the need to create one manually via CreateAgreementRequest.builder()
  
  Parameters:
  
  createAgreementRequest - A Consumer that will call methods on CreateAgreementRequest.Builder to create a request.
  
  Returns:
  
  Result of the CreateAgreement operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createConnector
  default CreateConnectorResponse createConnector(CreateConnectorRequest createConnectorRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AwsServiceException, SdkClientException, TransferException
  
  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:
  
  Result of the CreateConnector operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createConnector
  default CreateConnectorResponse createConnector(Consumer<CreateConnectorRequest.Builder> createConnectorRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AwsServiceException, SdkClientException, TransferException
  
  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 via CreateConnectorRequest.builder()
  
  Parameters:
  
  createConnectorRequest - A Consumer that will call methods on CreateConnectorRequest.Builder to create a request.
  
  Returns:
  
  Result of the CreateConnector operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createProfile
  default CreateProfileResponse createProfile(CreateProfileRequest createProfileRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Creates the local or partner profile to use for AS2 transfers.
  
  Parameters:
  
  createProfileRequest -
  
  Returns:
  
  Result of the CreateProfile operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createProfile
  default CreateProfileResponse createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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 via CreateProfileRequest.builder()
  
  Parameters:
  
  createProfileRequest - A Consumer that will call methods on CreateProfileRequest.Builder to create a request.
  
  Returns:
  
  Result of the CreateProfile operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createServer
  default CreateServerResponse createServer(CreateServerRequest createServerRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AccessDeniedException, AwsServiceException, SdkClientException, TransferException
  
  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:
  
  Result of the CreateServer operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createServer
  default CreateServerResponse createServer(Consumer<CreateServerRequest.Builder> createServerRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AccessDeniedException, AwsServiceException, SdkClientException, TransferException
  
  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 via CreateServerRequest.builder()
  
  Parameters:
  
  createServerRequest - A Consumer that will call methods on CreateServerRequest.Builder to create a request.
  
  Returns:
  
  Result of the CreateServer operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createUser
  default CreateUserResponse createUser(CreateUserRequest createUserRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AwsServiceException, SdkClientException, TransferException
  
  Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users.
  
  Parameters:
  
  createUserRequest -
  
  Returns:
  
  Result of the CreateUser operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createUser
  default CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AwsServiceException, SdkClientException, TransferException
  
  Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users.
  
  This is a convenience which creates an instance of the CreateUserRequest.Builder avoiding the need to create one manually via CreateUserRequest.builder()
  
  Parameters:
  
  createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request.
  
  Returns:
  
  Result of the CreateUser operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createWorkflow
  default CreateWorkflowResponse createWorkflow(CreateWorkflowRequest createWorkflowRequest) throws InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AccessDeniedException, AwsServiceException, SdkClientException, TransferException
  
  Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.
  
  Parameters:
  
  createWorkflowRequest -
  
  Returns:
  
  Result of the CreateWorkflow operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createWorkflow
  default CreateWorkflowResponse createWorkflow(Consumer<CreateWorkflowRequest.Builder> createWorkflowRequest) throws InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AccessDeniedException, AwsServiceException, SdkClientException, TransferException
  
  Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.
  
  This is a convenience which creates an instance of the CreateWorkflowRequest.Builder avoiding the need to create one manually via CreateWorkflowRequest.builder()
  
  Parameters:
  
  createWorkflowRequest - A Consumer that will call methods on CreateWorkflowRequest.Builder to create a request.
  
  Returns:
  
  Result of the CreateWorkflow operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteAccess
  default DeleteAccessResponse deleteAccess(DeleteAccessRequest deleteAccessRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Allows you to delete the access specified in the ServerID and ExternalID parameters.
  
  Parameters:
  
  deleteAccessRequest -
  
  Returns:
  
  Result of the DeleteAccess operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteAccess
  default DeleteAccessResponse deleteAccess(Consumer<DeleteAccessRequest.Builder> deleteAccessRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Allows you to delete the access specified in the ServerID and ExternalID parameters.
  
  This is a convenience which creates an instance of the DeleteAccessRequest.Builder avoiding the need to create one manually via DeleteAccessRequest.builder()
  
  Parameters:
  
  deleteAccessRequest - A Consumer that will call methods on DeleteAccessRequest.Builder to create a request.
  
  Returns:
  
  Result of the DeleteAccess operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteAgreement
  default DeleteAgreementResponse deleteAgreement(DeleteAgreementRequest deleteAgreementRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Delete the agreement that's specified in the provided AgreementId.
  
  Parameters:
  
  deleteAgreementRequest -
  
  Returns:
  
  Result of the DeleteAgreement operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteAgreement
  default DeleteAgreementResponse deleteAgreement(Consumer<DeleteAgreementRequest.Builder> deleteAgreementRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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 via DeleteAgreementRequest.builder()
  
  Parameters:
  
  deleteAgreementRequest - A Consumer that will call methods on DeleteAgreementRequest.Builder to create a request.
  
  Returns:
  
  Result of the DeleteAgreement operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteCertificate
  default DeleteCertificateResponse deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Deletes the certificate that's specified in the CertificateId parameter.
  
  Parameters:
  
  deleteCertificateRequest -
  
  Returns:
  
  Result of the DeleteCertificate operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteCertificate
  default DeleteCertificateResponse deleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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 via DeleteCertificateRequest.builder()
  
  Parameters:
  
  deleteCertificateRequest - A Consumer that will call methods on DeleteCertificateRequest.Builder to create a request.
  
  Returns:
  
  Result of the DeleteCertificate operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteConnector
  default DeleteConnectorResponse deleteConnector(DeleteConnectorRequest deleteConnectorRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Deletes the connector that's specified in the provided ConnectorId.
  
  Parameters:
  
  deleteConnectorRequest -
  
  Returns:
  
  Result of the DeleteConnector operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteConnector
  default DeleteConnectorResponse deleteConnector(Consumer<DeleteConnectorRequest.Builder> deleteConnectorRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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 via DeleteConnectorRequest.builder()
  
  Parameters:
  
  deleteConnectorRequest - A Consumer that will call methods on DeleteConnectorRequest.Builder to create a request.
  
  Returns:
  
  Result of the DeleteConnector operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteHostKey
  default DeleteHostKeyResponse deleteHostKey(DeleteHostKeyRequest deleteHostKeyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Deletes the host key that's specified in the HostKeyId parameter.
  
  Parameters:
  
  deleteHostKeyRequest -
  
  Returns:
  
  Result of the DeleteHostKey operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteHostKey
  default DeleteHostKeyResponse deleteHostKey(Consumer<DeleteHostKeyRequest.Builder> deleteHostKeyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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 via DeleteHostKeyRequest.builder()
  
  Parameters:
  
  deleteHostKeyRequest - A Consumer that will call methods on DeleteHostKeyRequest.Builder to create a request.
  
  Returns:
  
  Result of the DeleteHostKey operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteProfile
  default DeleteProfileResponse deleteProfile(DeleteProfileRequest deleteProfileRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Deletes the profile that's specified in the ProfileId parameter.
  
  Parameters:
  
  deleteProfileRequest -
  
  Returns:
  
  Result of the DeleteProfile operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteProfile
  default DeleteProfileResponse deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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 via DeleteProfileRequest.builder()
  
  Parameters:
  
  deleteProfileRequest - A Consumer that will call methods on DeleteProfileRequest.Builder to create a request.
  
  Returns:
  
  Result of the DeleteProfile operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteServer
  default DeleteServerResponse deleteServer(DeleteServerRequest deleteServerRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AccessDeniedException, AwsServiceException, SdkClientException, TransferException
  
  Deletes the file transfer protocol-enabled server that you specify.
  
  No response returns from this operation.
  
  Parameters:
  
  deleteServerRequest -
  
  Returns:
  
  Result of the DeleteServer operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteServer
  default DeleteServerResponse deleteServer(Consumer<DeleteServerRequest.Builder> deleteServerRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AccessDeniedException, AwsServiceException, SdkClientException, TransferException
  
  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 via DeleteServerRequest.builder()
  
  Parameters:
  
  deleteServerRequest - A Consumer that will call methods on DeleteServerRequest.Builder to create a request.
  
  Returns:
  
  Result of the DeleteServer operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteSshPublicKey
  default DeleteSshPublicKeyResponse deleteSshPublicKey(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Deletes a user's Secure Shell (SSH) public key.
  
  Parameters:
  
  deleteSshPublicKeyRequest -
  
  Returns:
  
  Result of the DeleteSshPublicKey operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteSshPublicKey
  default DeleteSshPublicKeyResponse deleteSshPublicKey(Consumer<DeleteSshPublicKeyRequest.Builder> deleteSshPublicKeyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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 via DeleteSshPublicKeyRequest.builder()
  
  Parameters:
  
  deleteSshPublicKeyRequest - A Consumer that will call methods on DeleteSshPublicKeyRequest.Builder to create a request.
  
  Returns:
  
  Result of the DeleteSshPublicKey operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteUser
  default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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:
  
  Result of the DeleteUser operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteUser
  default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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 via DeleteUserRequest.builder()
  
  Parameters:
  
  deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.
  
  Returns:
  
  Result of the DeleteUser operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteWorkflow
  default DeleteWorkflowResponse deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AccessDeniedException, AwsServiceException, SdkClientException, TransferException
  
  Deletes the specified workflow.
  
  Parameters:
  
  deleteWorkflowRequest -
  
  Returns:
  
  Result of the DeleteWorkflow operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteWorkflow
  default DeleteWorkflowResponse deleteWorkflow(Consumer<DeleteWorkflowRequest.Builder> deleteWorkflowRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AccessDeniedException, AwsServiceException, SdkClientException, TransferException
  
  Deletes the specified workflow.
  
  This is a convenience which creates an instance of the DeleteWorkflowRequest.Builder avoiding the need to create one manually via DeleteWorkflowRequest.builder()
  
  Parameters:
  
  deleteWorkflowRequest - A Consumer that will call methods on DeleteWorkflowRequest.Builder to create a request.
  
  Returns:
  
  Result of the DeleteWorkflow operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeAccess
  default DescribeAccessResponse describeAccess(DescribeAccessRequest describeAccessRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalId.
  
  The response from this call returns the properties of the access that is associated with the ServerId value that was specified.
  
  Parameters:
  
  describeAccessRequest -
  
  Returns:
  
  Result of the DescribeAccess operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeAccess
  default DescribeAccessResponse describeAccess(Consumer<DescribeAccessRequest.Builder> describeAccessRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalId.
  
  The response from this call returns the properties of the access that is associated with the ServerId value that was specified.
  
  This is a convenience which creates an instance of the DescribeAccessRequest.Builder avoiding the need to create one manually via DescribeAccessRequest.builder()
  
  Parameters:
  
  describeAccessRequest - A Consumer that will call methods on DescribeAccessRequest.Builder to create a request.
  
  Returns:
  
  Result of the DescribeAccess operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeAgreement
  default DescribeAgreementResponse describeAgreement(DescribeAgreementRequest describeAgreementRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Describes the agreement that's identified by the AgreementId.
  
  Parameters:
  
  describeAgreementRequest -
  
  Returns:
  
  Result of the DescribeAgreement operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeAgreement
  default DescribeAgreementResponse describeAgreement(Consumer<DescribeAgreementRequest.Builder> describeAgreementRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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 via DescribeAgreementRequest.builder()
  
  Parameters:
  
  describeAgreementRequest - A Consumer that will call methods on DescribeAgreementRequest.Builder to create a request.
  
  Returns:
  
  Result of the DescribeAgreement operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeCertificate
  default DescribeCertificateResponse describeCertificate(DescribeCertificateRequest describeCertificateRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Describes the certificate that's identified by the CertificateId.
  
  Parameters:
  
  describeCertificateRequest -
  
  Returns:
  
  Result of the DescribeCertificate operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeCertificate
  default DescribeCertificateResponse describeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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 via DescribeCertificateRequest.builder()
  
  Parameters:
  
  describeCertificateRequest - A Consumer that will call methods on DescribeCertificateRequest.Builder to create a request.
  
  Returns:
  
  Result of the DescribeCertificate operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeConnector
  default DescribeConnectorResponse describeConnector(DescribeConnectorRequest describeConnectorRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Describes the connector that's identified by the ConnectorId.
  
  Parameters:
  
  describeConnectorRequest -
  
  Returns:
  
  Result of the DescribeConnector operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeConnector
  default DescribeConnectorResponse describeConnector(Consumer<DescribeConnectorRequest.Builder> describeConnectorRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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 via DescribeConnectorRequest.builder()
  
  Parameters:
  
  describeConnectorRequest - A Consumer that will call methods on DescribeConnectorRequest.Builder to create a request.
  
  Returns:
  
  Result of the DescribeConnector operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeExecution
  default DescribeExecutionResponse describeExecution(DescribeExecutionRequest describeExecutionRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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:
  
  Result of the DescribeExecution operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeExecution
  default DescribeExecutionResponse describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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 via DescribeExecutionRequest.builder()
  
  Parameters:
  
  describeExecutionRequest - A Consumer that will call methods on DescribeExecutionRequest.Builder to create a request.
  
  Returns:
  
  Result of the DescribeExecution operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeHostKey
  default DescribeHostKeyResponse describeHostKey(DescribeHostKeyRequest describeHostKeyRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Returns the details of the host key that's specified by the HostKeyId and ServerId.
  
  Parameters:
  
  describeHostKeyRequest -
  
  Returns:
  
  Result of the DescribeHostKey operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeHostKey
  default DescribeHostKeyResponse describeHostKey(Consumer<DescribeHostKeyRequest.Builder> describeHostKeyRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Returns the details of the host key that's specified by the HostKeyId and ServerId.
  
  This is a convenience which creates an instance of the DescribeHostKeyRequest.Builder avoiding the need to create one manually via DescribeHostKeyRequest.builder()
  
  Parameters:
  
  describeHostKeyRequest - A Consumer that will call methods on DescribeHostKeyRequest.Builder to create a request.
  
  Returns:
  
  Result of the DescribeHostKey operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeProfile
  default DescribeProfileResponse describeProfile(DescribeProfileRequest describeProfileRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Returns the details of the profile that's specified by the ProfileId.
  
  Parameters:
  
  describeProfileRequest -
  
  Returns:
  
  Result of the DescribeProfile operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeProfile
  default DescribeProfileResponse describeProfile(Consumer<DescribeProfileRequest.Builder> describeProfileRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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 via DescribeProfileRequest.builder()
  
  Parameters:
  
  describeProfileRequest - A Consumer that will call methods on DescribeProfileRequest.Builder to create a request.
  
  Returns:
  
  Result of the DescribeProfile operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeSecurityPolicy
  default DescribeSecurityPolicyResponse describeSecurityPolicy(DescribeSecurityPolicyRequest describeSecurityPolicyRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.
  
  Parameters:
  
  describeSecurityPolicyRequest -
  
  Returns:
  
  Result of the DescribeSecurityPolicy operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeSecurityPolicy
  default DescribeSecurityPolicyResponse describeSecurityPolicy(Consumer<DescribeSecurityPolicyRequest.Builder> describeSecurityPolicyRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.
  
  This is a convenience which creates an instance of the DescribeSecurityPolicyRequest.Builder avoiding the need to create one manually via DescribeSecurityPolicyRequest.builder()
  
  Parameters:
  
  describeSecurityPolicyRequest - A Consumer that will call methods on DescribeSecurityPolicyRequest.Builder to create a request.
  
  Returns:
  
  Result of the DescribeSecurityPolicy operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeServer
  default DescribeServerResponse describeServer(DescribeServerRequest describeServerRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
  
  The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.
  
  Parameters:
  
  describeServerRequest -
  
  Returns:
  
  Result of the DescribeServer operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeServer
  default DescribeServerResponse describeServer(Consumer<DescribeServerRequest.Builder> describeServerRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
  
  The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.
  
  This is a convenience which creates an instance of the DescribeServerRequest.Builder avoiding the need to create one manually via DescribeServerRequest.builder()
  
  Parameters:
  
  describeServerRequest - A Consumer that will call methods on DescribeServerRequest.Builder to create a request.
  
  Returns:
  
  Result of the DescribeServer operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeUser
  default DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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:
  
  Result of the DescribeUser operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeUser
  default DescribeUserResponse describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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 via DescribeUserRequest.builder()
  
  Parameters:
  
  describeUserRequest - A Consumer that will call methods on DescribeUserRequest.Builder to create a request.
  
  Returns:
  
  Result of the DescribeUser operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeWorkflow
  default DescribeWorkflowResponse describeWorkflow(DescribeWorkflowRequest describeWorkflowRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Describes the specified workflow.
  
  Parameters:
  
  describeWorkflowRequest -
  
  Returns:
  
  Result of the DescribeWorkflow operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- describeWorkflow
  default DescribeWorkflowResponse describeWorkflow(Consumer<DescribeWorkflowRequest.Builder> describeWorkflowRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Describes the specified workflow.
  
  This is a convenience which creates an instance of the DescribeWorkflowRequest.Builder avoiding the need to create one manually via DescribeWorkflowRequest.builder()
  
  Parameters:
  
  describeWorkflowRequest - A Consumer that will call methods on DescribeWorkflowRequest.Builder to create a request.
  
  Returns:
  
  Result of the DescribeWorkflow operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- importCertificate
  default ImportCertificateResponse importCertificate(ImportCertificateRequest importCertificateRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.
  
  Parameters:
  
  importCertificateRequest -
  
  Returns:
  
  Result of the ImportCertificate operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- importCertificate
  default ImportCertificateResponse importCertificate(Consumer<ImportCertificateRequest.Builder> importCertificateRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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 via ImportCertificateRequest.builder()
  
  Parameters:
  
  importCertificateRequest - A Consumer that will call methods on ImportCertificateRequest.Builder to create a request.
  
  Returns:
  
  Result of the ImportCertificate operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- importHostKey
  default ImportHostKeyResponse importHostKey(ImportHostKeyRequest importHostKeyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AwsServiceException, SdkClientException, TransferException
  
  Adds a host key to the server that's specified by the ServerId parameter.
  
  Parameters:
  
  importHostKeyRequest -
  
  Returns:
  
  Result of the ImportHostKey operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- importHostKey
  default ImportHostKeyResponse importHostKey(Consumer<ImportHostKeyRequest.Builder> importHostKeyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AwsServiceException, SdkClientException, TransferException
  
  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 via ImportHostKeyRequest.builder()
  
  Parameters:
  
  importHostKeyRequest - A Consumer that will call methods on ImportHostKeyRequest.Builder to create a request.
  
  Returns:
  
  Result of the ImportHostKey operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- importSshPublicKey
  default ImportSshPublicKeyResponse importSshPublicKey(ImportSshPublicKeyRequest importSshPublicKeyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AwsServiceException, SdkClientException, TransferException
  
  Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId.
  
  The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.
  
  Parameters:
  
  importSshPublicKeyRequest -
  
  Returns:
  
  Result of the ImportSshPublicKey operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- importSshPublicKey
  default ImportSshPublicKeyResponse importSshPublicKey(Consumer<ImportSshPublicKeyRequest.Builder> importSshPublicKeyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AwsServiceException, SdkClientException, TransferException
  
  Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId.
  
  The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.
  
  This is a convenience which creates an instance of the ImportSshPublicKeyRequest.Builder avoiding the need to create one manually via ImportSshPublicKeyRequest.builder()
  
  Parameters:
  
  importSshPublicKeyRequest - A Consumer that will call methods on ImportSshPublicKeyRequest.Builder to create a request.
  
  Returns:
  
  Result of the ImportSshPublicKey operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listAccesses
  default ListAccessesResponse listAccesses(ListAccessesRequest listAccessesRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  Lists the details for all the accesses you have on your server.
  
  Parameters:
  
  listAccessesRequest -
  
  Returns:
  
  Result of the ListAccesses operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listAccesses
  default ListAccessesResponse listAccesses(Consumer<ListAccessesRequest.Builder> listAccessesRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  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 via ListAccessesRequest.builder()
  
  Parameters:
  
  listAccessesRequest - A Consumer that will call methods on ListAccessesRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListAccesses operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listAccessesPaginator
  default ListAccessesIterable listAccessesPaginator(ListAccessesRequest listAccessesRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listAccesses(software.amazon.awssdk.services.transfer.model.ListAccessesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListAccessesIterable responses = client.listAccessesPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListAccessesIterable responses = client.listAccessesPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListAccessesResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListAccessesIterable responses = client.listAccessesPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listAccesses(software.amazon.awssdk.services.transfer.model.ListAccessesRequest) operation.
  
  Parameters:
  
  listAccessesRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listAccessesPaginator
  default ListAccessesIterable listAccessesPaginator(Consumer<ListAccessesRequest.Builder> listAccessesRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listAccesses(software.amazon.awssdk.services.transfer.model.ListAccessesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListAccessesIterable responses = client.listAccessesPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListAccessesIterable responses = client.listAccessesPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListAccessesResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListAccessesIterable responses = client.listAccessesPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the 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 via ListAccessesRequest.builder()
  
  Parameters:
  
  listAccessesRequest - A Consumer that will call methods on ListAccessesRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listAgreements
  default ListAgreementsResponse listAgreements(ListAgreementsRequest listAgreementsRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  Returns a list of the agreements for the server that's identified by the ServerId that you supply. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing agreements from where you left off.
  
  Parameters:
  
  listAgreementsRequest -
  
  Returns:
  
  Result of the ListAgreements operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listAgreements
  default ListAgreementsResponse listAgreements(Consumer<ListAgreementsRequest.Builder> listAgreementsRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  Returns a list of the agreements for the server that's identified by the ServerId that you supply. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing agreements from where you left off.
  
  This is a convenience which creates an instance of the ListAgreementsRequest.Builder avoiding the need to create one manually via ListAgreementsRequest.builder()
  
  Parameters:
  
  listAgreementsRequest - A Consumer that will call methods on ListAgreementsRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListAgreements operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listAgreementsPaginator
  default ListAgreementsIterable listAgreementsPaginator(ListAgreementsRequest listAgreementsRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listAgreements(software.amazon.awssdk.services.transfer.model.ListAgreementsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListAgreementsIterable responses = client.listAgreementsPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListAgreementsIterable responses = client .listAgreementsPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListAgreementsResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListAgreementsIterable responses = client.listAgreementsPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listAgreements(software.amazon.awssdk.services.transfer.model.ListAgreementsRequest) operation.
  
  Parameters:
  
  listAgreementsRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listAgreementsPaginator
  default ListAgreementsIterable listAgreementsPaginator(Consumer<ListAgreementsRequest.Builder> listAgreementsRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listAgreements(software.amazon.awssdk.services.transfer.model.ListAgreementsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListAgreementsIterable responses = client.listAgreementsPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListAgreementsIterable responses = client .listAgreementsPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListAgreementsResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListAgreementsIterable responses = client.listAgreementsPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the 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 via ListAgreementsRequest.builder()
  
  Parameters:
  
  listAgreementsRequest - A Consumer that will call methods on ListAgreementsRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listCertificates
  default ListCertificatesResponse listCertificates(ListCertificatesRequest listCertificatesRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for the NextToken parameter, you can supply that value to continue listing certificates from where you left off.
  
  Parameters:
  
  listCertificatesRequest -
  
  Returns:
  
  Result of the ListCertificates operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listCertificates
  default ListCertificatesResponse listCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for the NextToken parameter, you can supply that value to continue listing certificates from where you left off.
  
  This is a convenience which creates an instance of the ListCertificatesRequest.Builder avoiding the need to create one manually via ListCertificatesRequest.builder()
  
  Parameters:
  
  listCertificatesRequest - A Consumer that will call methods on ListCertificatesRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListCertificates operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listCertificatesPaginator
  default ListCertificatesIterable listCertificatesPaginator(ListCertificatesRequest listCertificatesRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listCertificates(software.amazon.awssdk.services.transfer.model.ListCertificatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListCertificatesIterable responses = client .listCertificatesPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListCertificatesResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listCertificates(software.amazon.awssdk.services.transfer.model.ListCertificatesRequest) operation.
  
  Parameters:
  
  listCertificatesRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listCertificatesPaginator
  default ListCertificatesIterable listCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listCertificates(software.amazon.awssdk.services.transfer.model.ListCertificatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListCertificatesIterable responses = client .listCertificatesPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListCertificatesResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the 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 via ListCertificatesRequest.builder()
  
  Parameters:
  
  listCertificatesRequest - A Consumer that will call methods on ListCertificatesRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listConnectors
  default ListConnectorsResponse listConnectors(ListConnectorsRequest listConnectorsRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  Lists the connectors for the specified Region.
  
  Parameters:
  
  listConnectorsRequest -
  
  Returns:
  
  Result of the ListConnectors operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listConnectors
  default ListConnectorsResponse listConnectors(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  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 via ListConnectorsRequest.builder()
  
  Parameters:
  
  listConnectorsRequest - A Consumer that will call methods on ListConnectorsRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListConnectors operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listConnectorsPaginator
  default ListConnectorsIterable listConnectorsPaginator(ListConnectorsRequest listConnectorsRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listConnectors(software.amazon.awssdk.services.transfer.model.ListConnectorsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListConnectorsIterable responses = client .listConnectorsPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListConnectorsResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listConnectors(software.amazon.awssdk.services.transfer.model.ListConnectorsRequest) operation.
  
  Parameters:
  
  listConnectorsRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listConnectorsPaginator
  default ListConnectorsIterable listConnectorsPaginator(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listConnectors(software.amazon.awssdk.services.transfer.model.ListConnectorsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListConnectorsIterable responses = client .listConnectorsPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListConnectorsResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the 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 via ListConnectorsRequest.builder()
  
  Parameters:
  
  listConnectorsRequest - A Consumer that will call methods on ListConnectorsRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listExecutions
  default ListExecutionsResponse listExecutions(ListExecutionsRequest listExecutionsRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  Lists all in-progress executions for the specified workflow.
  
  If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.
  
  Parameters:
  
  listExecutionsRequest -
  
  Returns:
  
  Result of the ListExecutions operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listExecutions
  default ListExecutionsResponse listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  Lists all in-progress executions for the specified workflow.
  
  If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.
  
  This is a convenience which creates an instance of the ListExecutionsRequest.Builder avoiding the need to create one manually via ListExecutionsRequest.builder()
  
  Parameters:
  
  listExecutionsRequest - A Consumer that will call methods on ListExecutionsRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListExecutions operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listExecutionsPaginator
  default ListExecutionsIterable listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listExecutions(software.amazon.awssdk.services.transfer.model.ListExecutionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListExecutionsIterable responses = client .listExecutionsPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListExecutionsResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listExecutions(software.amazon.awssdk.services.transfer.model.ListExecutionsRequest) operation.
  
  Parameters:
  
  listExecutionsRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listExecutionsPaginator
  default ListExecutionsIterable listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listExecutions(software.amazon.awssdk.services.transfer.model.ListExecutionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListExecutionsIterable responses = client .listExecutionsPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListExecutionsResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the 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 via ListExecutionsRequest.builder()
  
  Parameters:
  
  listExecutionsRequest - A Consumer that will call methods on ListExecutionsRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listFileTransferResults
  default ListFileTransferResultsResponse listFileTransferResults(ListFileTransferResultsRequest listFileTransferResultsRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation. You specify the file transfer by providing its ConnectorId and its TransferId.
  
  File transfer results are available up to 7 days after an operation has been requested.
  
  Parameters:
  
  listFileTransferResultsRequest -
  
  Returns:
  
  Result of the ListFileTransferResults operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listFileTransferResults
  default ListFileTransferResultsResponse listFileTransferResults(Consumer<ListFileTransferResultsRequest.Builder> listFileTransferResultsRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation. You specify the file transfer by providing its ConnectorId and its TransferId.
  
  File transfer results are available up to 7 days after an operation has been requested.
  
  This is a convenience which creates an instance of the ListFileTransferResultsRequest.Builder avoiding the need to create one manually via ListFileTransferResultsRequest.builder()
  
  Parameters:
  
  listFileTransferResultsRequest - A Consumer that will call methods on ListFileTransferResultsRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListFileTransferResults operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listFileTransferResultsPaginator
  default ListFileTransferResultsIterable listFileTransferResultsPaginator(ListFileTransferResultsRequest listFileTransferResultsRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listFileTransferResults(software.amazon.awssdk.services.transfer.model.ListFileTransferResultsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListFileTransferResultsIterable responses = client.listFileTransferResultsPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListFileTransferResultsIterable responses = client .listFileTransferResultsPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListFileTransferResultsResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListFileTransferResultsIterable responses = client.listFileTransferResultsPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listFileTransferResults(software.amazon.awssdk.services.transfer.model.ListFileTransferResultsRequest) operation.
  
  Parameters:
  
  listFileTransferResultsRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listFileTransferResultsPaginator
  default ListFileTransferResultsIterable listFileTransferResultsPaginator(Consumer<ListFileTransferResultsRequest.Builder> listFileTransferResultsRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listFileTransferResults(software.amazon.awssdk.services.transfer.model.ListFileTransferResultsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListFileTransferResultsIterable responses = client.listFileTransferResultsPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListFileTransferResultsIterable responses = client .listFileTransferResultsPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListFileTransferResultsResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListFileTransferResultsIterable responses = client.listFileTransferResultsPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listFileTransferResults(software.amazon.awssdk.services.transfer.model.ListFileTransferResultsRequest) operation.
  
  This is a convenience which creates an instance of the ListFileTransferResultsRequest.Builder avoiding the need to create one manually via ListFileTransferResultsRequest.builder()
  
  Parameters:
  
  listFileTransferResultsRequest - A Consumer that will call methods on ListFileTransferResultsRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listHostKeys
  default ListHostKeysResponse listHostKeys(ListHostKeysRequest listHostKeysRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  Returns a list of host keys for the server that's specified by the ServerId parameter.
  
  Parameters:
  
  listHostKeysRequest -
  
  Returns:
  
  Result of the ListHostKeys operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listHostKeys
  default ListHostKeysResponse listHostKeys(Consumer<ListHostKeysRequest.Builder> listHostKeysRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  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 via ListHostKeysRequest.builder()
  
  Parameters:
  
  listHostKeysRequest - A Consumer that will call methods on ListHostKeysRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListHostKeys operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listProfiles
  default ListProfilesResponse listProfiles(ListProfilesRequest listProfilesRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing profiles from where you left off.
  
  Parameters:
  
  listProfilesRequest -
  
  Returns:
  
  Result of the ListProfiles operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listProfiles
  default ListProfilesResponse listProfiles(Consumer<ListProfilesRequest.Builder> listProfilesRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing profiles from where you left off.
  
  This is a convenience which creates an instance of the ListProfilesRequest.Builder avoiding the need to create one manually via ListProfilesRequest.builder()
  
  Parameters:
  
  listProfilesRequest - A Consumer that will call methods on ListProfilesRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListProfiles operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listProfilesPaginator
  default ListProfilesIterable listProfilesPaginator(ListProfilesRequest listProfilesRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listProfiles(software.amazon.awssdk.services.transfer.model.ListProfilesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListProfilesIterable responses = client.listProfilesPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListProfilesIterable responses = client.listProfilesPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListProfilesResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListProfilesIterable responses = client.listProfilesPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listProfiles(software.amazon.awssdk.services.transfer.model.ListProfilesRequest) operation.
  
  Parameters:
  
  listProfilesRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listProfilesPaginator
  default ListProfilesIterable listProfilesPaginator(Consumer<ListProfilesRequest.Builder> listProfilesRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listProfiles(software.amazon.awssdk.services.transfer.model.ListProfilesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListProfilesIterable responses = client.listProfilesPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListProfilesIterable responses = client.listProfilesPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListProfilesResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListProfilesIterable responses = client.listProfilesPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the 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 via ListProfilesRequest.builder()
  
  Parameters:
  
  listProfilesRequest - A Consumer that will call methods on ListProfilesRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listSecurityPolicies
  default ListSecurityPoliciesResponse listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest) throws InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  Lists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.
  
  Parameters:
  
  listSecurityPoliciesRequest -
  
  Returns:
  
  Result of the ListSecurityPolicies operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listSecurityPolicies
  default ListSecurityPoliciesResponse listSecurityPolicies(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest) throws InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  Lists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.
  
  This is a convenience which creates an instance of the ListSecurityPoliciesRequest.Builder avoiding the need to create one manually via ListSecurityPoliciesRequest.builder()
  
  Parameters:
  
  listSecurityPoliciesRequest - A Consumer that will call methods on ListSecurityPoliciesRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListSecurityPolicies operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listSecurityPoliciesPaginator
  default ListSecurityPoliciesIterable listSecurityPoliciesPaginator(ListSecurityPoliciesRequest listSecurityPoliciesRequest) throws InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesIterable responses = client.listSecurityPoliciesPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesIterable responses = client .listSecurityPoliciesPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesIterable responses = client.listSecurityPoliciesPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest) operation.
  
  Parameters:
  
  listSecurityPoliciesRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listSecurityPoliciesPaginator
  default ListSecurityPoliciesIterable listSecurityPoliciesPaginator(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest) throws InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesIterable responses = client.listSecurityPoliciesPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesIterable responses = client .listSecurityPoliciesPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesIterable responses = client.listSecurityPoliciesPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the 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 via ListSecurityPoliciesRequest.builder()
  
  Parameters:
  
  listSecurityPoliciesRequest - A Consumer that will call methods on ListSecurityPoliciesRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listServers
  default ListServersResponse listServers(ListServersRequest listServersRequest) throws InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
  
  Parameters:
  
  listServersRequest -
  
  Returns:
  
  Result of the ListServers operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listServers
  default ListServersResponse listServers(Consumer<ListServersRequest.Builder> listServersRequest) throws InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  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 via ListServersRequest.builder()
  
  Parameters:
  
  listServersRequest - A Consumer that will call methods on ListServersRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListServers operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listServers
  default ListServersResponse listServers() throws InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
  
  Returns:
  
  Result of the ListServers operation returned by the service.
  
  See Also:
  
  listServers(ListServersRequest)
  
  AWS API Documentation
- listServersPaginator
  default ListServersIterable listServersPaginator() throws InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListServersIterable responses = client.listServersPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListServersIterable responses = client.listServersPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListServersResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListServersIterable responses = client.listServersPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest) operation.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  listServersPaginator(ListServersRequest)
  
  AWS API Documentation
- listServersPaginator
  default ListServersIterable listServersPaginator(ListServersRequest listServersRequest) throws InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListServersIterable responses = client.listServersPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListServersIterable responses = client.listServersPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListServersResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListServersIterable responses = client.listServersPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest) operation.
  
  Parameters:
  
  listServersRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listServersPaginator
  default ListServersIterable listServersPaginator(Consumer<ListServersRequest.Builder> listServersRequest) throws InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListServersIterable responses = client.listServersPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListServersIterable responses = client.listServersPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListServersResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListServersIterable responses = client.listServersPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the 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 via ListServersRequest.builder()
  
  Parameters:
  
  listServersRequest - A Consumer that will call methods on ListServersRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listTagsForResource
  default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  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:
  
  Result of the ListTagsForResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listTagsForResource
  default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  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 via ListTagsForResourceRequest.builder()
  
  Parameters:
  
  listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListTagsForResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listTagsForResourcePaginator
  default ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.transfer.model.ListTagsForResourceResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest) operation.
  
  Parameters:
  
  listTagsForResourceRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listTagsForResourcePaginator
  default ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.transfer.model.ListTagsForResourceResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the 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 via ListTagsForResourceRequest.builder()
  
  Parameters:
  
  listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listUsers
  default ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
  
  Parameters:
  
  listUsersRequest -
  
  Returns:
  
  Result of the ListUsers operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listUsers
  default ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  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 via ListUsersRequest.builder()
  
  Parameters:
  
  listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListUsers operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listUsersPaginator
  default ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListUsersIterable responses = client.listUsersPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListUsersResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest) operation.
  
  Parameters:
  
  listUsersRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listUsersPaginator
  default ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListUsersIterable responses = client.listUsersPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListUsersResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the 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 via ListUsersRequest.builder()
  
  Parameters:
  
  listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listWorkflows
  default ListWorkflowsResponse listWorkflows(ListWorkflowsRequest listWorkflowsRequest) throws InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  Lists all workflows associated with your Amazon Web Services account for your current region.
  
  Parameters:
  
  listWorkflowsRequest -
  
  Returns:
  
  Result of the ListWorkflows operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listWorkflows
  default ListWorkflowsResponse listWorkflows(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest) throws InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  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 via ListWorkflowsRequest.builder()
  
  Parameters:
  
  listWorkflowsRequest - A Consumer that will call methods on ListWorkflowsRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListWorkflows operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listWorkflowsPaginator
  default ListWorkflowsIterable listWorkflowsPaginator(ListWorkflowsRequest listWorkflowsRequest) throws InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listWorkflows(software.amazon.awssdk.services.transfer.model.ListWorkflowsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListWorkflowsIterable responses = client.listWorkflowsPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListWorkflowsIterable responses = client.listWorkflowsPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListWorkflowsResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListWorkflowsIterable responses = client.listWorkflowsPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listWorkflows(software.amazon.awssdk.services.transfer.model.ListWorkflowsRequest) operation.
  
  Parameters:
  
  listWorkflowsRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listWorkflowsPaginator
  default ListWorkflowsIterable listWorkflowsPaginator(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest) throws InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, TransferException
  
  This is a variant of listWorkflows(software.amazon.awssdk.services.transfer.model.ListWorkflowsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.transfer.paginators.ListWorkflowsIterable responses = client.listWorkflowsPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.transfer.paginators.ListWorkflowsIterable responses = client.listWorkflowsPaginator(request); for (software.amazon.awssdk.services.transfer.model.ListWorkflowsResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.transfer.paginators.ListWorkflowsIterable responses = client.listWorkflowsPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the 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 via ListWorkflowsRequest.builder()
  
  Parameters:
  
  listWorkflowsRequest - A Consumer that will call methods on ListWorkflowsRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- sendWorkflowStepState
  default SendWorkflowStepStateResponse sendWorkflowStepState(SendWorkflowStepStateRequest sendWorkflowStepStateRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AccessDeniedException, AwsServiceException, SdkClientException, TransferException
  
  Sends a callback for asynchronous custom steps.
  
  The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status.
  
  Parameters:
  
  sendWorkflowStepStateRequest -
  
  Returns:
  
  Result of the SendWorkflowStepState operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- sendWorkflowStepState
  default SendWorkflowStepStateResponse sendWorkflowStepState(Consumer<SendWorkflowStepStateRequest.Builder> sendWorkflowStepStateRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AccessDeniedException, AwsServiceException, SdkClientException, TransferException
  
  Sends a callback for asynchronous custom steps.
  
  The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status.
  
  This is a convenience which creates an instance of the SendWorkflowStepStateRequest.Builder avoiding the need to create one manually via SendWorkflowStepStateRequest.builder()
  
  Parameters:
  
  sendWorkflowStepStateRequest - A Consumer that will call methods on SendWorkflowStepStateRequest.Builder to create a request.
  
  Returns:
  
  Result of the SendWorkflowStepState operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- startDirectoryListing
  default StartDirectoryListingResponse startDirectoryListing(StartDirectoryListingRequest startDirectoryListingRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Retrieves a list of the contents of a directory from a remote SFTP server. You specify the connector ID, the output path, and the remote directory path. You can also specify the optional MaxItems value to control the maximum number of items that are listed from the remote directory. This API returns a list of all files and directories in the remote directory (up to the maximum value), but does not return files or folders in sub-directories. That is, it only returns a list of files and directories one-level deep.
  
  After you receive the listing file, you can provide the files that you want to transfer to the RetrieveFilePaths parameter of the StartFileTransfer API call.
  
  The naming convention for the output file is connector-ID-listing-ID.json. The output file contains the following information:
  
  filePath: the complete path of a remote file, relative to the directory of the listing request for your SFTP connector on the remote server.
  
  modifiedTimestamp: the last time the file was modified, in UTC time format. This field is optional. If the remote file attributes don't contain a timestamp, it is omitted from the file listing.
  
  size: the size of the file, in bytes. This field is optional. If the remote file attributes don't contain a file size, it is omitted from the file listing.
  
  path: the complete path of a remote directory, relative to the directory of the listing request for your SFTP connector on the remote server.
  
  truncated: a flag indicating whether the list output contains all of the items contained in the remote directory or not. If your Truncated output value is true, you can increase the value provided in the optional max-items input attribute to be able to list more items (up to the maximum allowed list size of 10,000 items).
  
  Parameters:
  
  startDirectoryListingRequest -
  
  Returns:
  
  Result of the StartDirectoryListing operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- startDirectoryListing
  default StartDirectoryListingResponse startDirectoryListing(Consumer<StartDirectoryListingRequest.Builder> startDirectoryListingRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Retrieves a list of the contents of a directory from a remote SFTP server. You specify the connector ID, the output path, and the remote directory path. You can also specify the optional MaxItems value to control the maximum number of items that are listed from the remote directory. This API returns a list of all files and directories in the remote directory (up to the maximum value), but does not return files or folders in sub-directories. That is, it only returns a list of files and directories one-level deep.
  
  After you receive the listing file, you can provide the files that you want to transfer to the RetrieveFilePaths parameter of the StartFileTransfer API call.
  
  The naming convention for the output file is connector-ID-listing-ID.json. The output file contains the following information:
  
  filePath: the complete path of a remote file, relative to the directory of the listing request for your SFTP connector on the remote server.
  
  modifiedTimestamp: the last time the file was modified, in UTC time format. This field is optional. If the remote file attributes don't contain a timestamp, it is omitted from the file listing.
  
  size: the size of the file, in bytes. This field is optional. If the remote file attributes don't contain a file size, it is omitted from the file listing.
  
  path: the complete path of a remote directory, relative to the directory of the listing request for your SFTP connector on the remote server.
  
  truncated: a flag indicating whether the list output contains all of the items contained in the remote directory or not. If your Truncated output value is true, you can increase the value provided in the optional max-items input attribute to be able to list more items (up to the maximum allowed list size of 10,000 items).
  
  This is a convenience which creates an instance of the StartDirectoryListingRequest.Builder avoiding the need to create one manually via StartDirectoryListingRequest.builder()
  
  Parameters:
  
  startDirectoryListingRequest - A Consumer that will call methods on StartDirectoryListingRequest.Builder to create a request.
  
  Returns:
  
  Result of the StartDirectoryListing operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- startFileTransfer
  default StartFileTransferResponse startFileTransfer(StartFileTransferRequest startFileTransferRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
  
  For an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files you want to transfer.
  
  For an SFTP connector, the file transfer can be either outbound or inbound. In both cases, you specify the ConnectorId. Depending on the direction of the transfer, you also specify the following items:
  
  If you are transferring file from a partner's SFTP server to Amazon Web Services storage, you specify one or more RetrieveFilePaths to identify the files you want to transfer, and a LocalDirectoryPath to specify the destination folder.
  
  If you are transferring file to a partner's SFTP server from Amazon Web Services storage, you specify one or more SendFilePaths to identify the files you want to transfer, and a RemoteDirectoryPath to specify the destination folder.
  
  Parameters:
  
  startFileTransferRequest -
  
  Returns:
  
  Result of the StartFileTransfer operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- startFileTransfer
  default StartFileTransferResponse startFileTransfer(Consumer<StartFileTransferRequest.Builder> startFileTransferRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
  
  For an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files you want to transfer.
  
  For an SFTP connector, the file transfer can be either outbound or inbound. In both cases, you specify the ConnectorId. Depending on the direction of the transfer, you also specify the following items:
  
  If you are transferring file from a partner's SFTP server to Amazon Web Services storage, you specify one or more RetrieveFilePaths to identify the files you want to transfer, and a LocalDirectoryPath to specify the destination folder.
  
  If you are transferring file to a partner's SFTP server from Amazon Web Services storage, you specify one or more SendFilePaths to identify the files you want to transfer, and a RemoteDirectoryPath to specify the destination folder.
  
  This is a convenience which creates an instance of the StartFileTransferRequest.Builder avoiding the need to create one manually via StartFileTransferRequest.builder()
  
  Parameters:
  
  startFileTransferRequest - A Consumer that will call methods on StartFileTransferRequest.Builder to create a request.
  
  Returns:
  
  Result of the StartFileTransfer operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- startServer
  default StartServerResponse startServer(StartServerRequest startServerRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.
  
  The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.
  
  No response is returned from this call.
  
  Parameters:
  
  startServerRequest -
  
  Returns:
  
  Result of the StartServer operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- startServer
  default StartServerResponse startServer(Consumer<StartServerRequest.Builder> startServerRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.
  
  The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.
  
  No response is returned from this call.
  
  This is a convenience which creates an instance of the StartServerRequest.Builder avoiding the need to create one manually via StartServerRequest.builder()
  
  Parameters:
  
  startServerRequest - A Consumer that will call methods on StartServerRequest.Builder to create a request.
  
  Returns:
  
  Result of the StartServer operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- stopServer
  default StopServerResponse stopServer(StopServerRequest stopServerRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server.
  
  Stopping the server does not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.
  
  The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.
  
  No response is returned from this call.
  
  Parameters:
  
  stopServerRequest -
  
  Returns:
  
  Result of the StopServer operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- stopServer
  default StopServerResponse stopServer(Consumer<StopServerRequest.Builder> stopServerRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server.
  
  Stopping the server does not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.
  
  The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.
  
  No response is returned from this call.
  
  This is a convenience which creates an instance of the StopServerRequest.Builder avoiding the need to create one manually via StopServerRequest.builder()
  
  Parameters:
  
  stopServerRequest - A Consumer that will call methods on StopServerRequest.Builder to create a request.
  
  Returns:
  
  Result of the StopServer operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- tagResource
  default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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:
  
  Result of the TagResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- tagResource
  default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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 via TagResourceRequest.builder()
  
  Parameters:
  
  tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
  
  Returns:
  
  Result of the TagResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- testConnection
  default TestConnectionResponse testConnection(TestConnectionRequest testConnectionRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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:
  
  Result of the TestConnection operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- testConnection
  default TestConnectionResponse testConnection(Consumer<TestConnectionRequest.Builder> testConnectionRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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 via TestConnectionRequest.builder()
  
  Parameters:
  
  testConnectionRequest - A Consumer that will call methods on TestConnectionRequest.Builder to create a request.
  
  Returns:
  
  Result of the TestConnection operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- testIdentityProvider
  default TestIdentityProviderResponse testIdentityProvider(TestIdentityProviderRequest testIdentityProviderRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service.
  
  The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional.
  
  Note the following:
  
  You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED.
  
  TestIdentityProvider does not work with keys: it only accepts passwords.
  
  TestIdentityProvider can test the password operation for a custom Identity Provider that handles keys and passwords.
  
  If you provide any incorrect values for any parameters, the Response field is empty.
  
  If you provide a server ID for a server that uses service-managed users, you get an error:
  
  An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth
  
  If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer server, you receive the following error:
  
  An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server .
  
  It is possible your sever is in a different region. You can specify a region by adding the following: --region region-code, such as --region us-east-2 to specify a server in US East (Ohio).
  
  Parameters:
  
  testIdentityProviderRequest -
  
  Returns:
  
  Result of the TestIdentityProvider operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- testIdentityProvider
  default TestIdentityProviderResponse testIdentityProvider(Consumer<TestIdentityProviderRequest.Builder> testIdentityProviderRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service.
  
  The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional.
  
  Note the following:
  
  You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED.
  
  TestIdentityProvider does not work with keys: it only accepts passwords.
  
  TestIdentityProvider can test the password operation for a custom Identity Provider that handles keys and passwords.
  
  If you provide any incorrect values for any parameters, the Response field is empty.
  
  If you provide a server ID for a server that uses service-managed users, you get an error:
  
  An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth
  
  If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer server, you receive the following error:
  
  An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server .
  
  It is possible your sever is in a different region. You can specify a region by adding the following: --region region-code, such as --region us-east-2 to specify a server in US East (Ohio).
  
  This is a convenience which creates an instance of the TestIdentityProviderRequest.Builder avoiding the need to create one manually via TestIdentityProviderRequest.builder()
  
  Parameters:
  
  testIdentityProviderRequest - A Consumer that will call methods on TestIdentityProviderRequest.Builder to create a request.
  
  Returns:
  
  Result of the TestIdentityProvider operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- untagResource
  default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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:
  
  Result of the UntagResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- untagResource
  default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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 via UntagResourceRequest.builder()
  
  Parameters:
  
  untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
  
  Returns:
  
  Result of the UntagResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateAccess
  default UpdateAccessResponse updateAccess(UpdateAccessRequest updateAccessRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AwsServiceException, SdkClientException, TransferException
  
  Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.
  
  Parameters:
  
  updateAccessRequest -
  
  Returns:
  
  Result of the UpdateAccess operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateAccess
  default UpdateAccessResponse updateAccess(Consumer<UpdateAccessRequest.Builder> updateAccessRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AwsServiceException, SdkClientException, TransferException
  
  Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.
  
  This is a convenience which creates an instance of the UpdateAccessRequest.Builder avoiding the need to create one manually via UpdateAccessRequest.builder()
  
  Parameters:
  
  updateAccessRequest - A Consumer that will call methods on UpdateAccessRequest.Builder to create a request.
  
  Returns:
  
  Result of the UpdateAccess operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateAgreement
  default UpdateAgreementResponse updateAgreement(UpdateAgreementRequest updateAgreementRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AwsServiceException, SdkClientException, TransferException
  
  Updates some of the parameters for an existing agreement. Provide the AgreementId and the ServerId for the agreement that you want to update, along with the new values for the parameters to update.
  
  Parameters:
  
  updateAgreementRequest -
  
  Returns:
  
  Result of the UpdateAgreement operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateAgreement
  default UpdateAgreementResponse updateAgreement(Consumer<UpdateAgreementRequest.Builder> updateAgreementRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AwsServiceException, SdkClientException, TransferException
  
  Updates some of the parameters for an existing agreement. Provide the AgreementId and the ServerId for the agreement that you want to update, along with the new values for the parameters to update.
  
  This is a convenience which creates an instance of the UpdateAgreementRequest.Builder avoiding the need to create one manually via UpdateAgreementRequest.builder()
  
  Parameters:
  
  updateAgreementRequest - A Consumer that will call methods on UpdateAgreementRequest.Builder to create a request.
  
  Returns:
  
  Result of the UpdateAgreement operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateCertificate
  default UpdateCertificateResponse updateCertificate(UpdateCertificateRequest updateCertificateRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Updates the active and inactive dates for a certificate.
  
  Parameters:
  
  updateCertificateRequest -
  
  Returns:
  
  Result of the UpdateCertificate operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateCertificate
  default UpdateCertificateResponse updateCertificate(Consumer<UpdateCertificateRequest.Builder> updateCertificateRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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 via UpdateCertificateRequest.builder()
  
  Parameters:
  
  updateCertificateRequest - A Consumer that will call methods on UpdateCertificateRequest.Builder to create a request.
  
  Returns:
  
  Result of the UpdateCertificate operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateConnector
  default UpdateConnectorResponse updateConnector(UpdateConnectorRequest updateConnectorRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AwsServiceException, SdkClientException, TransferException
  
  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:
  
  Result of the UpdateConnector operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateConnector
  default UpdateConnectorResponse updateConnector(Consumer<UpdateConnectorRequest.Builder> updateConnectorRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AwsServiceException, SdkClientException, TransferException
  
  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 via UpdateConnectorRequest.builder()
  
  Parameters:
  
  updateConnectorRequest - A Consumer that will call methods on UpdateConnectorRequest.Builder to create a request.
  
  Returns:
  
  Result of the UpdateConnector operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateHostKey
  default UpdateHostKeyResponse updateHostKey(UpdateHostKeyRequest updateHostKeyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Updates the description for the host key that's specified by the ServerId and HostKeyId parameters.
  
  Parameters:
  
  updateHostKeyRequest -
  
  Returns:
  
  Result of the UpdateHostKey operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateHostKey
  default UpdateHostKeyResponse updateHostKey(Consumer<UpdateHostKeyRequest.Builder> updateHostKeyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Updates the description for the host key that's specified by the ServerId and HostKeyId parameters.
  
  This is a convenience which creates an instance of the UpdateHostKeyRequest.Builder avoiding the need to create one manually via UpdateHostKeyRequest.builder()
  
  Parameters:
  
  updateHostKeyRequest - A Consumer that will call methods on UpdateHostKeyRequest.Builder to create a request.
  
  Returns:
  
  Result of the UpdateHostKey operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateProfile
  default UpdateProfileResponse updateProfile(UpdateProfileRequest updateProfileRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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:
  
  Result of the UpdateProfile operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateProfile
  default UpdateProfileResponse updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  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 via UpdateProfileRequest.builder()
  
  Parameters:
  
  updateProfileRequest - A Consumer that will call methods on UpdateProfileRequest.Builder to create a request.
  
  Returns:
  
  Result of the UpdateProfile operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateServer
  default UpdateServerResponse updateServer(UpdateServerRequest updateServerRequest) throws ConflictException, ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AccessDeniedException, AwsServiceException, SdkClientException, TransferException
  
  Updates the file transfer protocol-enabled server's properties after that server has been created.
  
  The UpdateServer call returns the ServerId of the server you updated.
  
  Parameters:
  
  updateServerRequest -
  
  Returns:
  
  Result of the UpdateServer operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateServer
  default UpdateServerResponse updateServer(Consumer<UpdateServerRequest.Builder> updateServerRequest) throws ConflictException, ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, ResourceExistsException, AccessDeniedException, AwsServiceException, SdkClientException, TransferException
  
  Updates the file transfer protocol-enabled server's properties after that server has been created.
  
  The UpdateServer call returns the ServerId of the server you updated.
  
  This is a convenience which creates an instance of the UpdateServerRequest.Builder avoiding the need to create one manually via UpdateServerRequest.builder()
  
  Parameters:
  
  updateServerRequest - A Consumer that will call methods on UpdateServerRequest.Builder to create a request.
  
  Returns:
  
  Result of the UpdateServer operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateUser
  default UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify.
  
  The response returns the ServerId and the UserName for the updated user.
  
  In the console, you can select Restricted when you create or update a user. This ensures that the user can't access anything outside of their home directory. The programmatic way to configure this behavior is to update the user. Set their HomeDirectoryType to LOGICAL, and specify HomeDirectoryMappings with Entry as root (/) and Target as their home directory.
  
  For example, if the user's home directory is /test/admin-user, the following command updates the user so that their configuration in the console shows the Restricted flag as selected.
  
  aws transfer update-user --server-id <server-id> --user-name admin-user --home-directory-type LOGICAL --home-directory-mappings "[{\"Entry\":\"/\", \"Target\":\"/test/admin-user\"}]"
  
  Parameters:
  
  updateUserRequest -
  
  Returns:
  
  Result of the UpdateUser operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateUser
  default UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalServiceErrorException, ServiceUnavailableException, AwsServiceException, SdkClientException, TransferException
  
  Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify.
  
  The response returns the ServerId and the UserName for the updated user.
  
  In the console, you can select Restricted when you create or update a user. This ensures that the user can't access anything outside of their home directory. The programmatic way to configure this behavior is to update the user. Set their HomeDirectoryType to LOGICAL, and specify HomeDirectoryMappings with Entry as root (/) and Target as their home directory.
  
  For example, if the user's home directory is /test/admin-user, the following command updates the user so that their configuration in the console shows the Restricted flag as selected.
  
  aws transfer update-user --server-id <server-id> --user-name admin-user --home-directory-type LOGICAL --home-directory-mappings "[{\"Entry\":\"/\", \"Target\":\"/test/admin-user\"}]"
  
  This is a convenience which creates an instance of the UpdateUserRequest.Builder avoiding the need to create one manually via UpdateUserRequest.builder()
  
  Parameters:
  
  updateUserRequest - A Consumer that will call methods on UpdateUserRequest.Builder to create a request.
  
  Returns:
  
  Result of the UpdateUser operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- waiter
  
  default TransferWaiter waiter()
  
  Create an instance of TransferWaiter 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 TransferWaiter
- create
  
  static TransferClient create()
  
  Create a TransferClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
- builder
  
  static TransferClientBuilder builder()
  
  Create a builder that can be used to configure and create a TransferClient.
- serviceMetadata
  
  static ServiceMetadata serviceMetadata()
- serviceClientConfiguration
  
  default TransferServiceClientConfiguration serviceClientConfiguration()
  
  Description copied from interface: SdkClient
  
  The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
  
  Specified by:
  
  serviceClientConfiguration in interface AwsClient
  
  Specified by:
  
  serviceClientConfiguration in interface SdkClient
  
  Returns:
  
  SdkServiceClientConfiguration

Interface TransferClient

Field Summary

Method Summary

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

Methods inherited from interface software.amazon.awssdk.core.SdkClient

Field Details

SERVICE_NAME

SERVICE_METADATA_ID

Method Details

createAccess

createAccess

createAgreement

createAgreement

createConnector

createConnector

createProfile

createProfile

createServer

createServer

createUser

createUser

createWorkflow

createWorkflow

deleteAccess

deleteAccess

deleteAgreement

deleteAgreement

deleteCertificate

deleteCertificate

deleteConnector

deleteConnector

deleteHostKey

deleteHostKey

deleteProfile

deleteProfile

deleteServer

deleteServer

deleteSshPublicKey

deleteSshPublicKey

deleteUser

deleteUser

deleteWorkflow

deleteWorkflow

describeAccess

describeAccess

describeAgreement

describeAgreement

describeCertificate

describeCertificate

describeConnector

describeConnector

describeExecution

describeExecution

describeHostKey

describeHostKey

describeProfile

describeProfile

describeSecurityPolicy

describeSecurityPolicy

describeServer

describeServer

describeUser

describeUser

describeWorkflow

describeWorkflow

importCertificate

importCertificate

importHostKey

importHostKey

importSshPublicKey

importSshPublicKey

listAccesses

listAccesses

listAccessesPaginator

listAccessesPaginator

listAgreements

listAgreements

listAgreementsPaginator

listAgreementsPaginator

listCertificates