@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface TransferAsyncClient extends AwsClient
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 for processing, analytics, machine learning, and archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and set up.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static TransferAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
TransferAsyncClient. |
static TransferAsyncClient |
create()
Create a
TransferAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateAccessResponse> |
createAccess(Consumer<CreateAccessRequest.Builder> createAccessRequest)
Used by administrators to choose which groups in the directory should have access to upload and download files
over the enabled protocols using Transfer Family.
|
default CompletableFuture<CreateAccessResponse> |
createAccess(CreateAccessRequest createAccessRequest)
Used by administrators to choose which groups in the directory should have access to upload and download files
over the enabled protocols using Transfer Family.
|
default CompletableFuture<CreateAgreementResponse> |
createAgreement(Consumer<CreateAgreementRequest.Builder> createAgreementRequest)
Creates an agreement.
|
default CompletableFuture<CreateAgreementResponse> |
createAgreement(CreateAgreementRequest createAgreementRequest)
Creates an agreement.
|
default CompletableFuture<CreateConnectorResponse> |
createConnector(Consumer<CreateConnectorRequest.Builder> createConnectorRequest)
Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.
|
default CompletableFuture<CreateConnectorResponse> |
createConnector(CreateConnectorRequest createConnectorRequest)
Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.
|
default CompletableFuture<CreateProfileResponse> |
createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest)
Creates the local or partner profile to use for AS2 transfers.
|
default CompletableFuture<CreateProfileResponse> |
createProfile(CreateProfileRequest createProfileRequest)
Creates the local or partner profile to use for AS2 transfers.
|
default CompletableFuture<CreateServerResponse> |
createServer(Consumer<CreateServerRequest.Builder> createServerRequest)
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.
|
default CompletableFuture<CreateServerResponse> |
createServer(CreateServerRequest createServerRequest)
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.
|
default CompletableFuture<CreateUserResponse> |
createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user and associates them with an existing file transfer protocol-enabled server.
|
default CompletableFuture<CreateUserResponse> |
createUser(CreateUserRequest createUserRequest)
Creates a user and associates them with an existing file transfer protocol-enabled server.
|
default CompletableFuture<CreateWorkflowResponse> |
createWorkflow(Consumer<CreateWorkflowRequest.Builder> createWorkflowRequest)
Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer
completes.
|
default CompletableFuture<CreateWorkflowResponse> |
createWorkflow(CreateWorkflowRequest createWorkflowRequest)
Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer
completes.
|
default CompletableFuture<DeleteAccessResponse> |
deleteAccess(Consumer<DeleteAccessRequest.Builder> deleteAccessRequest)
Allows you to delete the access specified in the
ServerID and ExternalID parameters. |
default CompletableFuture<DeleteAccessResponse> |
deleteAccess(DeleteAccessRequest deleteAccessRequest)
Allows you to delete the access specified in the
ServerID and ExternalID parameters. |
default CompletableFuture<DeleteAgreementResponse> |
deleteAgreement(Consumer<DeleteAgreementRequest.Builder> deleteAgreementRequest)
Delete the agreement that's specified in the provided
AgreementId. |
default CompletableFuture<DeleteAgreementResponse> |
deleteAgreement(DeleteAgreementRequest deleteAgreementRequest)
Delete the agreement that's specified in the provided
AgreementId. |
default CompletableFuture<DeleteCertificateResponse> |
deleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest)
Deletes the certificate that's specified in the
CertificateId parameter. |
default CompletableFuture<DeleteCertificateResponse> |
deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
Deletes the certificate that's specified in the
CertificateId parameter. |
default CompletableFuture<DeleteConnectorResponse> |
deleteConnector(Consumer<DeleteConnectorRequest.Builder> deleteConnectorRequest)
Deletes the connector that's specified in the provided
ConnectorId. |
default CompletableFuture<DeleteConnectorResponse> |
deleteConnector(DeleteConnectorRequest deleteConnectorRequest)
Deletes the connector that's specified in the provided
ConnectorId. |
default CompletableFuture<DeleteHostKeyResponse> |
deleteHostKey(Consumer<DeleteHostKeyRequest.Builder> deleteHostKeyRequest)
Deletes the host key that's specified in the
HostKeyId parameter. |
default CompletableFuture<DeleteHostKeyResponse> |
deleteHostKey(DeleteHostKeyRequest deleteHostKeyRequest)
Deletes the host key that's specified in the
HostKeyId parameter. |
default CompletableFuture<DeleteProfileResponse> |
deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest)
Deletes the profile that's specified in the
ProfileId parameter. |
default CompletableFuture<DeleteProfileResponse> |
deleteProfile(DeleteProfileRequest deleteProfileRequest)
Deletes the profile that's specified in the
ProfileId parameter. |
default CompletableFuture<DeleteServerResponse> |
deleteServer(Consumer<DeleteServerRequest.Builder> deleteServerRequest)
Deletes the file transfer protocol-enabled server that you specify.
|
default CompletableFuture<DeleteServerResponse> |
deleteServer(DeleteServerRequest deleteServerRequest)
Deletes the file transfer protocol-enabled server that you specify.
|
default CompletableFuture<DeleteSshPublicKeyResponse> |
deleteSshPublicKey(Consumer<DeleteSshPublicKeyRequest.Builder> deleteSshPublicKeyRequest)
Deletes a user's Secure Shell (SSH) public key.
|
default CompletableFuture<DeleteSshPublicKeyResponse> |
deleteSshPublicKey(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest)
Deletes a user's Secure Shell (SSH) public key.
|
default CompletableFuture<DeleteUserResponse> |
deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes the user belonging to a file transfer protocol-enabled server you specify.
|
default CompletableFuture<DeleteUserResponse> |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the user belonging to a file transfer protocol-enabled server you specify.
|
default CompletableFuture<DeleteWorkflowResponse> |
deleteWorkflow(Consumer<DeleteWorkflowRequest.Builder> deleteWorkflowRequest)
Deletes the specified workflow.
|
default CompletableFuture<DeleteWorkflowResponse> |
deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest)
Deletes the specified workflow.
|
default CompletableFuture<DescribeAccessResponse> |
describeAccess(Consumer<DescribeAccessRequest.Builder> describeAccessRequest)
Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property and its ExternalId. |
default CompletableFuture<DescribeAccessResponse> |
describeAccess(DescribeAccessRequest describeAccessRequest)
Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property and its ExternalId. |
default CompletableFuture<DescribeAgreementResponse> |
describeAgreement(Consumer<DescribeAgreementRequest.Builder> describeAgreementRequest)
Describes the agreement that's identified by the
AgreementId. |
default CompletableFuture<DescribeAgreementResponse> |
describeAgreement(DescribeAgreementRequest describeAgreementRequest)
Describes the agreement that's identified by the
AgreementId. |
default CompletableFuture<DescribeCertificateResponse> |
describeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest)
Describes the certificate that's identified by the
CertificateId. |
default CompletableFuture<DescribeCertificateResponse> |
describeCertificate(DescribeCertificateRequest describeCertificateRequest)
Describes the certificate that's identified by the
CertificateId. |
default CompletableFuture<DescribeConnectorResponse> |
describeConnector(Consumer<DescribeConnectorRequest.Builder> describeConnectorRequest)
Describes the connector that's identified by the
ConnectorId. |
default CompletableFuture<DescribeConnectorResponse> |
describeConnector(DescribeConnectorRequest describeConnectorRequest)
Describes the connector that's identified by the
ConnectorId. |
default CompletableFuture<DescribeExecutionResponse> |
describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest)
You can use
DescribeExecution to check the details of the execution of the specified workflow. |
default CompletableFuture<DescribeExecutionResponse> |
describeExecution(DescribeExecutionRequest describeExecutionRequest)
You can use
DescribeExecution to check the details of the execution of the specified workflow. |
default CompletableFuture<DescribeHostKeyResponse> |
describeHostKey(Consumer<DescribeHostKeyRequest.Builder> describeHostKeyRequest)
Returns the details of the host key that's specified by the
HostKeyId and ServerId. |
default CompletableFuture<DescribeHostKeyResponse> |
describeHostKey(DescribeHostKeyRequest describeHostKeyRequest)
Returns the details of the host key that's specified by the
HostKeyId and ServerId. |
default CompletableFuture<DescribeProfileResponse> |
describeProfile(Consumer<DescribeProfileRequest.Builder> describeProfileRequest)
Returns the details of the profile that's specified by the
ProfileId. |
default CompletableFuture<DescribeProfileResponse> |
describeProfile(DescribeProfileRequest describeProfileRequest)
Returns the details of the profile that's specified by the
ProfileId. |
default CompletableFuture<DescribeSecurityPolicyResponse> |
describeSecurityPolicy(Consumer<DescribeSecurityPolicyRequest.Builder> describeSecurityPolicyRequest)
Describes the security policy that is attached to your file transfer protocol-enabled server.
|
default CompletableFuture<DescribeSecurityPolicyResponse> |
describeSecurityPolicy(DescribeSecurityPolicyRequest describeSecurityPolicyRequest)
Describes the security policy that is attached to your file transfer protocol-enabled server.
|
default CompletableFuture<DescribeServerResponse> |
describeServer(Consumer<DescribeServerRequest.Builder> describeServerRequest)
Describes a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
default CompletableFuture<DescribeServerResponse> |
describeServer(DescribeServerRequest describeServerRequest)
Describes a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
default CompletableFuture<DescribeUserResponse> |
describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property. |
default CompletableFuture<DescribeUserResponse> |
describeUser(DescribeUserRequest describeUserRequest)
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property. |
default CompletableFuture<DescribeWorkflowResponse> |
describeWorkflow(Consumer<DescribeWorkflowRequest.Builder> describeWorkflowRequest)
Describes the specified workflow.
|
default CompletableFuture<DescribeWorkflowResponse> |
describeWorkflow(DescribeWorkflowRequest describeWorkflowRequest)
Describes the specified workflow.
|
default CompletableFuture<ImportCertificateResponse> |
importCertificate(Consumer<ImportCertificateRequest.Builder> importCertificateRequest)
Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner
profiles.
|
default CompletableFuture<ImportCertificateResponse> |
importCertificate(ImportCertificateRequest importCertificateRequest)
Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner
profiles.
|
default CompletableFuture<ImportHostKeyResponse> |
importHostKey(Consumer<ImportHostKeyRequest.Builder> importHostKeyRequest)
Adds a host key to the server that's specified by the
ServerId parameter. |
default CompletableFuture<ImportHostKeyResponse> |
importHostKey(ImportHostKeyRequest importHostKeyRequest)
Adds a host key to the server that's specified by the
ServerId parameter. |
default CompletableFuture<ImportSshPublicKeyResponse> |
importSshPublicKey(Consumer<ImportSshPublicKeyRequest.Builder> importSshPublicKeyRequest)
Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a
UserName value
assigned to the specific file transfer protocol-enabled server, identified by ServerId. |
default CompletableFuture<ImportSshPublicKeyResponse> |
importSshPublicKey(ImportSshPublicKeyRequest importSshPublicKeyRequest)
Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a
UserName value
assigned to the specific file transfer protocol-enabled server, identified by ServerId. |
default CompletableFuture<ListAccessesResponse> |
listAccesses(Consumer<ListAccessesRequest.Builder> listAccessesRequest)
Lists the details for all the accesses you have on your server.
|
default CompletableFuture<ListAccessesResponse> |
listAccesses(ListAccessesRequest listAccessesRequest)
Lists the details for all the accesses you have on your server.
|
default ListAccessesPublisher |
listAccessesPaginator(Consumer<ListAccessesRequest.Builder> listAccessesRequest)
Lists the details for all the accesses you have on your server.
|
default ListAccessesPublisher |
listAccessesPaginator(ListAccessesRequest listAccessesRequest)
Lists the details for all the accesses you have on your server.
|
default CompletableFuture<ListAgreementsResponse> |
listAgreements(Consumer<ListAgreementsRequest.Builder> listAgreementsRequest)
Returns a list of the agreements for the server that's identified by the
ServerId that you supply. |
default CompletableFuture<ListAgreementsResponse> |
listAgreements(ListAgreementsRequest listAgreementsRequest)
Returns a list of the agreements for the server that's identified by the
ServerId that you supply. |
default ListAgreementsPublisher |
listAgreementsPaginator(Consumer<ListAgreementsRequest.Builder> listAgreementsRequest)
Returns a list of the agreements for the server that's identified by the
ServerId that you supply. |
default ListAgreementsPublisher |
listAgreementsPaginator(ListAgreementsRequest listAgreementsRequest)
Returns a list of the agreements for the server that's identified by the
ServerId that you supply. |
default CompletableFuture<ListCertificatesResponse> |
listCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)
Returns a list of the current certificates that have been imported into Transfer Family.
|
default CompletableFuture<ListCertificatesResponse> |
listCertificates(ListCertificatesRequest listCertificatesRequest)
Returns a list of the current certificates that have been imported into Transfer Family.
|
default ListCertificatesPublisher |
listCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)
Returns a list of the current certificates that have been imported into Transfer Family.
|
default ListCertificatesPublisher |
listCertificatesPaginator(ListCertificatesRequest listCertificatesRequest)
Returns a list of the current certificates that have been imported into Transfer Family.
|
default CompletableFuture<ListConnectorsResponse> |
listConnectors(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest)
Lists the connectors for the specified Region.
|
default CompletableFuture<ListConnectorsResponse> |
listConnectors(ListConnectorsRequest listConnectorsRequest)
Lists the connectors for the specified Region.
|
default ListConnectorsPublisher |
listConnectorsPaginator(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest)
Lists the connectors for the specified Region.
|
default ListConnectorsPublisher |
listConnectorsPaginator(ListConnectorsRequest listConnectorsRequest)
Lists the connectors for the specified Region.
|
default CompletableFuture<ListExecutionsResponse> |
listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Lists all in-progress executions for the specified workflow.
|
default CompletableFuture<ListExecutionsResponse> |
listExecutions(ListExecutionsRequest listExecutionsRequest)
Lists all in-progress executions for the specified workflow.
|
default ListExecutionsPublisher |
listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Lists all in-progress executions for the specified workflow.
|
default ListExecutionsPublisher |
listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)
Lists all in-progress executions for the specified workflow.
|
default CompletableFuture<ListHostKeysResponse> |
listHostKeys(Consumer<ListHostKeysRequest.Builder> listHostKeysRequest)
Returns a list of host keys for the server that's specified by the
ServerId parameter. |
default CompletableFuture<ListHostKeysResponse> |
listHostKeys(ListHostKeysRequest listHostKeysRequest)
Returns a list of host keys for the server that's specified by the
ServerId parameter. |
default CompletableFuture<ListProfilesResponse> |
listProfiles(Consumer<ListProfilesRequest.Builder> listProfilesRequest)
Returns a list of the profiles for your system.
|
default CompletableFuture<ListProfilesResponse> |
listProfiles(ListProfilesRequest listProfilesRequest)
Returns a list of the profiles for your system.
|
default ListProfilesPublisher |
listProfilesPaginator(Consumer<ListProfilesRequest.Builder> listProfilesRequest)
Returns a list of the profiles for your system.
|
default ListProfilesPublisher |
listProfilesPaginator(ListProfilesRequest listProfilesRequest)
Returns a list of the profiles for your system.
|
default CompletableFuture<ListSecurityPoliciesResponse> |
listSecurityPolicies(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
|
default CompletableFuture<ListSecurityPoliciesResponse> |
listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
|
default ListSecurityPoliciesPublisher |
listSecurityPoliciesPaginator(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
|
default ListSecurityPoliciesPublisher |
listSecurityPoliciesPaginator(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
|
default CompletableFuture<ListServersResponse> |
listServers()
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
|
default CompletableFuture<ListServersResponse> |
listServers(Consumer<ListServersRequest.Builder> listServersRequest)
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
|
default CompletableFuture<ListServersResponse> |
listServers(ListServersRequest listServersRequest)
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
|
default ListServersPublisher |
listServersPaginator()
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
|
default ListServersPublisher |
listServersPaginator(Consumer<ListServersRequest.Builder> listServersRequest)
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
|
default ListServersPublisher |
listServersPaginator(ListServersRequest listServersRequest)
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
|
default ListTagsForResourcePublisher |
listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
|
default ListTagsForResourcePublisher |
listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
|
default CompletableFuture<ListUsersResponse> |
listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
default CompletableFuture<ListUsersResponse> |
listUsers(ListUsersRequest listUsersRequest)
Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
default ListUsersPublisher |
listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
default ListUsersPublisher |
listUsersPaginator(ListUsersRequest listUsersRequest)
Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. |
default CompletableFuture<ListWorkflowsResponse> |
listWorkflows(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest)
Lists all workflows associated with your Amazon Web Services account for your current region.
|
default CompletableFuture<ListWorkflowsResponse> |
listWorkflows(ListWorkflowsRequest listWorkflowsRequest)
Lists all workflows associated with your Amazon Web Services account for your current region.
|
default ListWorkflowsPublisher |
listWorkflowsPaginator(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest)
Lists all workflows associated with your Amazon Web Services account for your current region.
|
default ListWorkflowsPublisher |
listWorkflowsPaginator(ListWorkflowsRequest listWorkflowsRequest)
Lists all workflows associated with your Amazon Web Services account for your current region.
|
default CompletableFuture<SendWorkflowStepStateResponse> |
sendWorkflowStepState(Consumer<SendWorkflowStepStateRequest.Builder> sendWorkflowStepStateRequest)
Sends a callback for asynchronous custom steps.
|
default CompletableFuture<SendWorkflowStepStateResponse> |
sendWorkflowStepState(SendWorkflowStepStateRequest sendWorkflowStepStateRequest)
Sends a callback for asynchronous custom steps.
|
default TransferServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<StartFileTransferResponse> |
startFileTransfer(Consumer<StartFileTransferRequest.Builder> startFileTransferRequest)
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
|
default CompletableFuture<StartFileTransferResponse> |
startFileTransfer(StartFileTransferRequest startFileTransferRequest)
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
|
default CompletableFuture<StartServerResponse> |
startServer(Consumer<StartServerRequest.Builder> startServerRequest)
Changes the state of a file transfer protocol-enabled server from
OFFLINE to ONLINE. |
default CompletableFuture<StartServerResponse> |
startServer(StartServerRequest startServerRequest)
Changes the state of a file transfer protocol-enabled server from
OFFLINE to ONLINE. |
default CompletableFuture<StopServerResponse> |
stopServer(Consumer<StopServerRequest.Builder> stopServerRequest)
Changes the state of a file transfer protocol-enabled server from
ONLINE to OFFLINE. |
default CompletableFuture<StopServerResponse> |
stopServer(StopServerRequest stopServerRequest)
Changes the state of a file transfer protocol-enabled server from
ONLINE to OFFLINE. |
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
|
default CompletableFuture<TestConnectionResponse> |
testConnection(Consumer<TestConnectionRequest.Builder> testConnectionRequest)
Tests whether your SFTP connector is set up successfully.
|
default CompletableFuture<TestConnectionResponse> |
testConnection(TestConnectionRequest testConnectionRequest)
Tests whether your SFTP connector is set up successfully.
|
default CompletableFuture<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 CompletableFuture<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 CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
|
default CompletableFuture<UpdateAccessResponse> |
updateAccess(Consumer<UpdateAccessRequest.Builder> updateAccessRequest)
Allows you to update parameters for the access specified in the
ServerID and ExternalID
parameters. |
default CompletableFuture<UpdateAccessResponse> |
updateAccess(UpdateAccessRequest updateAccessRequest)
Allows you to update parameters for the access specified in the
ServerID and ExternalID
parameters. |
default CompletableFuture<UpdateAgreementResponse> |
updateAgreement(Consumer<UpdateAgreementRequest.Builder> updateAgreementRequest)
Updates some of the parameters for an existing agreement.
|
default CompletableFuture<UpdateAgreementResponse> |
updateAgreement(UpdateAgreementRequest updateAgreementRequest)
Updates some of the parameters for an existing agreement.
|
default CompletableFuture<UpdateCertificateResponse> |
updateCertificate(Consumer<UpdateCertificateRequest.Builder> updateCertificateRequest)
Updates the active and inactive dates for a certificate.
|
default CompletableFuture<UpdateCertificateResponse> |
updateCertificate(UpdateCertificateRequest updateCertificateRequest)
Updates the active and inactive dates for a certificate.
|
default CompletableFuture<UpdateConnectorResponse> |
updateConnector(Consumer<UpdateConnectorRequest.Builder> updateConnectorRequest)
Updates some of the parameters for an existing connector.
|
default CompletableFuture<UpdateConnectorResponse> |
updateConnector(UpdateConnectorRequest updateConnectorRequest)
Updates some of the parameters for an existing connector.
|
default CompletableFuture<UpdateHostKeyResponse> |
updateHostKey(Consumer<UpdateHostKeyRequest.Builder> updateHostKeyRequest)
Updates the description for the host key that's specified by the
ServerId and HostKeyId
parameters. |
default CompletableFuture<UpdateHostKeyResponse> |
updateHostKey(UpdateHostKeyRequest updateHostKeyRequest)
Updates the description for the host key that's specified by the
ServerId and HostKeyId
parameters. |
default CompletableFuture<UpdateProfileResponse> |
updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest)
Updates some of the parameters for an existing profile.
|
default CompletableFuture<UpdateProfileResponse> |
updateProfile(UpdateProfileRequest updateProfileRequest)
Updates some of the parameters for an existing profile.
|
default CompletableFuture<UpdateServerResponse> |
updateServer(Consumer<UpdateServerRequest.Builder> updateServerRequest)
Updates the file transfer protocol-enabled server's properties after that server has been created.
|
default CompletableFuture<UpdateServerResponse> |
updateServer(UpdateServerRequest updateServerRequest)
Updates the file transfer protocol-enabled server's properties after that server has been created.
|
default CompletableFuture<UpdateUserResponse> |
updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
Assigns new properties to a user.
|
default CompletableFuture<UpdateUserResponse> |
updateUser(UpdateUserRequest updateUserRequest)
Assigns new properties to a user.
|
default TransferAsyncWaiter |
waiter()
Create an instance of
TransferAsyncWaiter using this client. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CreateAccessResponse> createAccess(CreateAccessRequest createAccessRequest)
Used by administrators to choose which groups in the directory should have access to upload and download files
over the enabled protocols using Transfer Family. For example, a Microsoft Active Directory might contain 50,000
users, but only a small fraction might need the ability to transfer files to the server. An administrator can use
CreateAccess to limit the access to the correct set of users who need this ability.
createAccessRequest - default CompletableFuture<CreateAccessResponse> createAccess(Consumer<CreateAccessRequest.Builder> createAccessRequest)
Used by administrators to choose which groups in the directory should have access to upload and download files
over the enabled protocols using Transfer Family. For example, a Microsoft Active Directory might contain 50,000
users, but only a small fraction might need the ability to transfer files to the server. An administrator can use
CreateAccess to limit the access to the correct set of users who need this ability.
This is a convenience which creates an instance of the CreateAccessRequest.Builder avoiding the need to
create one manually via CreateAccessRequest.builder()
createAccessRequest - A Consumer that will call methods on
CreateAccessRequest.Builder to create a request.default CompletableFuture<CreateAgreementResponse> createAgreement(CreateAgreementRequest createAgreementRequest)
Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.
The partner is identified with the PartnerProfileId, and the AS2 process is identified with the
LocalProfileId.
createAgreementRequest - default CompletableFuture<CreateAgreementResponse> createAgreement(Consumer<CreateAgreementRequest.Builder> createAgreementRequest)
Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.
The partner is identified with the PartnerProfileId, and the AS2 process is identified with the
LocalProfileId.
This is a convenience which creates an instance of the CreateAgreementRequest.Builder avoiding the need
to create one manually via CreateAgreementRequest.builder()
createAgreementRequest - A Consumer that will call methods on
CreateAgreementRequest.Builder to create a request.default CompletableFuture<CreateConnectorResponse> createConnector(CreateConnectorRequest createConnectorRequest)
Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server. For more details about connectors, see Create AS2 connectors and Create SFTP connectors.
You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (
SftpConfig).
createConnectorRequest - default CompletableFuture<CreateConnectorResponse> createConnector(Consumer<CreateConnectorRequest.Builder> createConnectorRequest)
Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server. For more details about connectors, see Create 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()
createConnectorRequest - A Consumer that will call methods on
CreateConnectorRequest.Builder to create a request.default CompletableFuture<CreateProfileResponse> createProfile(CreateProfileRequest createProfileRequest)
Creates the local or partner profile to use for AS2 transfers.
createProfileRequest - default CompletableFuture<CreateProfileResponse> createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest)
Creates the local or partner profile to use for AS2 transfers.
This is a convenience which creates an instance of the CreateProfileRequest.Builder avoiding the need to
create one manually via CreateProfileRequest.builder()
createProfileRequest - A Consumer that will call methods on
CreateProfileRequest.Builder to create a request.default CompletableFuture<CreateServerResponse> createServer(CreateServerRequest createServerRequest)
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.
When you make updates to your file transfer protocol-enabled server or when you work with users, use the
service-generated ServerId property that is assigned to the newly created server.
createServerRequest - default CompletableFuture<CreateServerResponse> createServer(Consumer<CreateServerRequest.Builder> createServerRequest)
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.
When you make updates to your file transfer protocol-enabled server or when you work with users, use the
service-generated ServerId property that is assigned to the newly created server.
This is a convenience which creates an instance of the CreateServerRequest.Builder avoiding the need to
create one manually via CreateServerRequest.builder()
createServerRequest - A Consumer that will call methods on
CreateServerRequest.Builder to create a request.default CompletableFuture<CreateUserResponse> createUser(CreateUserRequest createUserRequest)
Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create
and associate users with servers that have the IdentityProviderType set to
SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set
the home directory, store the user's public key, and assign the user's Identity and Access Management (IAM) role.
You can also optionally add a session policy, and assign metadata with tags that can be used to group and search
for users.
createUserRequest - default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create
and associate users with servers that have the IdentityProviderType set 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()
createUserRequest - A Consumer that will call methods on
CreateUserRequest.Builder to create a request.default CompletableFuture<CreateWorkflowResponse> createWorkflow(CreateWorkflowRequest createWorkflowRequest)
Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer
completes. After creating a workflow, you can associate the workflow created with any transfer servers by
specifying the workflow-details field in CreateServer and UpdateServer
operations.
createWorkflowRequest - default CompletableFuture<CreateWorkflowResponse> createWorkflow(Consumer<CreateWorkflowRequest.Builder> createWorkflowRequest)
Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer
completes. After creating a workflow, you can associate the workflow created with any transfer servers by
specifying the workflow-details field 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()
createWorkflowRequest - A Consumer that will call methods on
CreateWorkflowRequest.Builder to create a request.default CompletableFuture<DeleteAccessResponse> deleteAccess(DeleteAccessRequest deleteAccessRequest)
Allows you to delete the access specified in the ServerID and ExternalID parameters.
deleteAccessRequest - default CompletableFuture<DeleteAccessResponse> deleteAccess(Consumer<DeleteAccessRequest.Builder> deleteAccessRequest)
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()
deleteAccessRequest - A Consumer that will call methods on
DeleteAccessRequest.Builder to create a request.default CompletableFuture<DeleteAgreementResponse> deleteAgreement(DeleteAgreementRequest deleteAgreementRequest)
Delete the agreement that's specified in the provided AgreementId.
deleteAgreementRequest - default CompletableFuture<DeleteAgreementResponse> deleteAgreement(Consumer<DeleteAgreementRequest.Builder> deleteAgreementRequest)
Delete the agreement that's specified in the provided AgreementId.
This is a convenience which creates an instance of the DeleteAgreementRequest.Builder avoiding the need
to create one manually via DeleteAgreementRequest.builder()
deleteAgreementRequest - A Consumer that will call methods on
DeleteAgreementRequest.Builder to create a request.default CompletableFuture<DeleteCertificateResponse> deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
Deletes the certificate that's specified in the CertificateId parameter.
deleteCertificateRequest - default CompletableFuture<DeleteCertificateResponse> deleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest)
Deletes the certificate that's specified in the CertificateId parameter.
This is a convenience which creates an instance of the DeleteCertificateRequest.Builder avoiding the need
to create one manually via DeleteCertificateRequest.builder()
deleteCertificateRequest - A Consumer that will call methods on
DeleteCertificateRequest.Builder to create a
request.default CompletableFuture<DeleteConnectorResponse> deleteConnector(DeleteConnectorRequest deleteConnectorRequest)
Deletes the connector that's specified in the provided ConnectorId.
deleteConnectorRequest - default CompletableFuture<DeleteConnectorResponse> deleteConnector(Consumer<DeleteConnectorRequest.Builder> deleteConnectorRequest)
Deletes the connector that's specified in the provided ConnectorId.
This is a convenience which creates an instance of the DeleteConnectorRequest.Builder avoiding the need
to create one manually via DeleteConnectorRequest.builder()
deleteConnectorRequest - A Consumer that will call methods on
DeleteConnectorRequest.Builder to create a request.default CompletableFuture<DeleteHostKeyResponse> deleteHostKey(DeleteHostKeyRequest deleteHostKeyRequest)
Deletes the host key that's specified in the HostKeyId parameter.
deleteHostKeyRequest - default CompletableFuture<DeleteHostKeyResponse> deleteHostKey(Consumer<DeleteHostKeyRequest.Builder> deleteHostKeyRequest)
Deletes the host key that's specified in the HostKeyId parameter.
This is a convenience which creates an instance of the DeleteHostKeyRequest.Builder avoiding the need to
create one manually via DeleteHostKeyRequest.builder()
deleteHostKeyRequest - A Consumer that will call methods on
DeleteHostKeyRequest.Builder to create a request.default CompletableFuture<DeleteProfileResponse> deleteProfile(DeleteProfileRequest deleteProfileRequest)
Deletes the profile that's specified in the ProfileId parameter.
deleteProfileRequest - default CompletableFuture<DeleteProfileResponse> deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest)
Deletes the profile that's specified in the ProfileId parameter.
This is a convenience which creates an instance of the DeleteProfileRequest.Builder avoiding the need to
create one manually via DeleteProfileRequest.builder()
deleteProfileRequest - A Consumer that will call methods on
DeleteProfileRequest.Builder to create a request.default CompletableFuture<DeleteServerResponse> deleteServer(DeleteServerRequest deleteServerRequest)
Deletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.
deleteServerRequest - default CompletableFuture<DeleteServerResponse> deleteServer(Consumer<DeleteServerRequest.Builder> deleteServerRequest)
Deletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.
This is a convenience which creates an instance of the DeleteServerRequest.Builder avoiding the need to
create one manually via DeleteServerRequest.builder()
deleteServerRequest - A Consumer that will call methods on
DeleteServerRequest.Builder to create a request.default CompletableFuture<DeleteSshPublicKeyResponse> deleteSshPublicKey(DeleteSshPublicKeyRequest deleteSshPublicKeyRequest)
Deletes a user's Secure Shell (SSH) public key.
deleteSshPublicKeyRequest - default CompletableFuture<DeleteSshPublicKeyResponse> deleteSshPublicKey(Consumer<DeleteSshPublicKeyRequest.Builder> deleteSshPublicKeyRequest)
Deletes a user's Secure Shell (SSH) public key.
This is a convenience which creates an instance of the DeleteSshPublicKeyRequest.Builder avoiding the
need to create one manually via DeleteSshPublicKeyRequest.builder()
deleteSshPublicKeyRequest - A Consumer that will call methods on
DeleteSshPublicKeyRequest.Builder to create a
request.default CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the user belonging to a file transfer protocol-enabled server you specify.
No response returns from this operation.
When you delete a user from a server, the user's information is lost.
deleteUserRequest - default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes the user belonging to a file transfer protocol-enabled server you specify.
No response returns from this operation.
When you delete a user from a server, the user's information is lost.
This is a convenience which creates an instance of the DeleteUserRequest.Builder avoiding the need to
create one manually via DeleteUserRequest.builder()
deleteUserRequest - A Consumer that will call methods on
DeleteUserRequest.Builder to create a request.default CompletableFuture<DeleteWorkflowResponse> deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest)
Deletes the specified workflow.
deleteWorkflowRequest - default CompletableFuture<DeleteWorkflowResponse> deleteWorkflow(Consumer<DeleteWorkflowRequest.Builder> deleteWorkflowRequest)
Deletes the specified workflow.
This is a convenience which creates an instance of the DeleteWorkflowRequest.Builder avoiding the need to
create one manually via DeleteWorkflowRequest.builder()
deleteWorkflowRequest - A Consumer that will call methods on
DeleteWorkflowRequest.Builder to create a request.default CompletableFuture<DescribeAccessResponse> describeAccess(DescribeAccessRequest describeAccessRequest)
Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property and its ExternalId.
The response from this call returns the properties of the access that is associated with the
ServerId value that was specified.
describeAccessRequest - default CompletableFuture<DescribeAccessResponse> describeAccess(Consumer<DescribeAccessRequest.Builder> describeAccessRequest)
Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property and 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()
describeAccessRequest - A Consumer that will call methods on
DescribeAccessRequest.Builder to create a request.default CompletableFuture<DescribeAgreementResponse> describeAgreement(DescribeAgreementRequest describeAgreementRequest)
Describes the agreement that's identified by the AgreementId.
describeAgreementRequest - default CompletableFuture<DescribeAgreementResponse> describeAgreement(Consumer<DescribeAgreementRequest.Builder> describeAgreementRequest)
Describes the agreement that's identified by the AgreementId.
This is a convenience which creates an instance of the DescribeAgreementRequest.Builder avoiding the need
to create one manually via DescribeAgreementRequest.builder()
describeAgreementRequest - A Consumer that will call methods on
DescribeAgreementRequest.Builder to create a
request.default CompletableFuture<DescribeCertificateResponse> describeCertificate(DescribeCertificateRequest describeCertificateRequest)
Describes the certificate that's identified by the CertificateId.
describeCertificateRequest - default CompletableFuture<DescribeCertificateResponse> describeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest)
Describes the certificate that's identified by the CertificateId.
This is a convenience which creates an instance of the DescribeCertificateRequest.Builder avoiding the
need to create one manually via DescribeCertificateRequest.builder()
describeCertificateRequest - A Consumer that will call methods on
DescribeCertificateRequest.Builder to create a
request.default CompletableFuture<DescribeConnectorResponse> describeConnector(DescribeConnectorRequest describeConnectorRequest)
Describes the connector that's identified by the ConnectorId.
describeConnectorRequest - default CompletableFuture<DescribeConnectorResponse> describeConnector(Consumer<DescribeConnectorRequest.Builder> describeConnectorRequest)
Describes the connector that's identified by the ConnectorId.
This is a convenience which creates an instance of the DescribeConnectorRequest.Builder avoiding the need
to create one manually via DescribeConnectorRequest.builder()
describeConnectorRequest - A Consumer that will call methods on
DescribeConnectorRequest.Builder to create a
request.default CompletableFuture<DescribeExecutionResponse> describeExecution(DescribeExecutionRequest describeExecutionRequest)
You can use DescribeExecution to check the details of the execution of the specified workflow.
This API call only returns details for in-progress workflows.
If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified
workflow ID, you receive a ResourceNotFound exception.
describeExecutionRequest - default CompletableFuture<DescribeExecutionResponse> describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest)
You can use DescribeExecution to check the details of the execution of the specified workflow.
This API call only returns details for in-progress workflows.
If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified
workflow ID, you receive a ResourceNotFound exception.
This is a convenience which creates an instance of the DescribeExecutionRequest.Builder avoiding the need
to create one manually via DescribeExecutionRequest.builder()
describeExecutionRequest - A Consumer that will call methods on
DescribeExecutionRequest.Builder to create a
request.default CompletableFuture<DescribeHostKeyResponse> describeHostKey(DescribeHostKeyRequest describeHostKeyRequest)
Returns the details of the host key that's specified by the HostKeyId and ServerId.
describeHostKeyRequest - default CompletableFuture<DescribeHostKeyResponse> describeHostKey(Consumer<DescribeHostKeyRequest.Builder> describeHostKeyRequest)
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()
describeHostKeyRequest - A Consumer that will call methods on
DescribeHostKeyRequest.Builder to create a request.default CompletableFuture<DescribeProfileResponse> describeProfile(DescribeProfileRequest describeProfileRequest)
Returns the details of the profile that's specified by the ProfileId.
describeProfileRequest - default CompletableFuture<DescribeProfileResponse> describeProfile(Consumer<DescribeProfileRequest.Builder> describeProfileRequest)
Returns the details of the profile that's specified by the ProfileId.
This is a convenience which creates an instance of the DescribeProfileRequest.Builder avoiding the need
to create one manually via DescribeProfileRequest.builder()
describeProfileRequest - A Consumer that will call methods on
DescribeProfileRequest.Builder to create a request.default CompletableFuture<DescribeSecurityPolicyResponse> describeSecurityPolicy(DescribeSecurityPolicyRequest describeSecurityPolicyRequest)
Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies.
describeSecurityPolicyRequest - default CompletableFuture<DescribeSecurityPolicyResponse> describeSecurityPolicy(Consumer<DescribeSecurityPolicyRequest.Builder> describeSecurityPolicyRequest)
Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies.
This is a convenience which creates an instance of the DescribeSecurityPolicyRequest.Builder avoiding the
need to create one manually via DescribeSecurityPolicyRequest.builder()
describeSecurityPolicyRequest - A Consumer that will call methods on
DescribeSecurityPolicyRequest.Builder to create a
request.default CompletableFuture<DescribeServerResponse> describeServer(DescribeServerRequest describeServerRequest)
Describes a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
The response contains a description of a server's properties. When you set EndpointType to VPC, the
response will contain the EndpointDetails.
describeServerRequest - default CompletableFuture<DescribeServerResponse> describeServer(Consumer<DescribeServerRequest.Builder> describeServerRequest)
Describes a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
The response contains a description of a server's properties. When you set EndpointType to VPC, the
response will contain the EndpointDetails.
This is a convenience which creates an instance of the DescribeServerRequest.Builder avoiding the need to
create one manually via DescribeServerRequest.builder()
describeServerRequest - A Consumer that will call methods on
DescribeServerRequest.Builder to create a request.default CompletableFuture<DescribeUserResponse> describeUser(DescribeUserRequest describeUserRequest)
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property.
The response from this call returns the properties of the user associated with the ServerId value
that was specified.
describeUserRequest - default CompletableFuture<DescribeUserResponse> describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId property.
The response from this call returns the properties of the user associated with the ServerId value
that was specified.
This is a convenience which creates an instance of the DescribeUserRequest.Builder avoiding the need to
create one manually via DescribeUserRequest.builder()
describeUserRequest - A Consumer that will call methods on
DescribeUserRequest.Builder to create a request.default CompletableFuture<DescribeWorkflowResponse> describeWorkflow(DescribeWorkflowRequest describeWorkflowRequest)
Describes the specified workflow.
describeWorkflowRequest - default CompletableFuture<DescribeWorkflowResponse> describeWorkflow(Consumer<DescribeWorkflowRequest.Builder> describeWorkflowRequest)
Describes the specified workflow.
This is a convenience which creates an instance of the DescribeWorkflowRequest.Builder avoiding the need
to create one manually via DescribeWorkflowRequest.builder()
describeWorkflowRequest - A Consumer that will call methods on
DescribeWorkflowRequest.Builder to create a
request.default CompletableFuture<ImportCertificateResponse> importCertificate(ImportCertificateRequest importCertificateRequest)
Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.
importCertificateRequest - default CompletableFuture<ImportCertificateResponse> importCertificate(Consumer<ImportCertificateRequest.Builder> importCertificateRequest)
Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.
This is a convenience which creates an instance of the ImportCertificateRequest.Builder avoiding the need
to create one manually via ImportCertificateRequest.builder()
importCertificateRequest - A Consumer that will call methods on
ImportCertificateRequest.Builder to create a
request.default CompletableFuture<ImportHostKeyResponse> importHostKey(ImportHostKeyRequest importHostKeyRequest)
Adds a host key to the server that's specified by the ServerId parameter.
importHostKeyRequest - default CompletableFuture<ImportHostKeyResponse> importHostKey(Consumer<ImportHostKeyRequest.Builder> importHostKeyRequest)
Adds a host key to the server that's specified by the ServerId parameter.
This is a convenience which creates an instance of the ImportHostKeyRequest.Builder avoiding the need to
create one manually via ImportHostKeyRequest.builder()
importHostKeyRequest - A Consumer that will call methods on
ImportHostKeyRequest.Builder to create a request.default CompletableFuture<ImportSshPublicKeyResponse> importSshPublicKey(ImportSshPublicKeyRequest importSshPublicKeyRequest)
Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a UserName value
assigned to the specific file transfer protocol-enabled server, identified by ServerId.
The response returns the UserName value, the ServerId value, and the name of the
SshPublicKeyId.
importSshPublicKeyRequest - default CompletableFuture<ImportSshPublicKeyResponse> importSshPublicKey(Consumer<ImportSshPublicKeyRequest.Builder> importSshPublicKeyRequest)
Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a UserName value
assigned to the specific file transfer protocol-enabled server, identified 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()
importSshPublicKeyRequest - A Consumer that will call methods on
ImportSshPublicKeyRequest.Builder to create a
request.default CompletableFuture<ListAccessesResponse> listAccesses(ListAccessesRequest listAccessesRequest)
Lists the details for all the accesses you have on your server.
listAccessesRequest - NextToken parameter that was passed is invalid.default CompletableFuture<ListAccessesResponse> listAccesses(Consumer<ListAccessesRequest.Builder> listAccessesRequest)
Lists the details for all the accesses you have on your server.
This is a convenience which creates an instance of the ListAccessesRequest.Builder avoiding the need to
create one manually via ListAccessesRequest.builder()
listAccessesRequest - A Consumer that will call methods on
ListAccessesRequest.Builder to create a request.NextToken parameter that was passed is invalid.default ListAccessesPublisher listAccessesPaginator(ListAccessesRequest listAccessesRequest)
Lists the details for all the accesses you have on your server.
This is a variant of listAccesses(software.amazon.awssdk.services.transfer.model.ListAccessesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListAccessesPublisher publisher = client.listAccessesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListAccessesPublisher publisher = client.listAccessesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListAccessesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListAccessesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listAccessesRequest - NextToken parameter that was passed is invalid.default ListAccessesPublisher listAccessesPaginator(Consumer<ListAccessesRequest.Builder> listAccessesRequest)
Lists the details for all the accesses you have on your server.
This is a variant of listAccesses(software.amazon.awssdk.services.transfer.model.ListAccessesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListAccessesPublisher publisher = client.listAccessesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListAccessesPublisher publisher = client.listAccessesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListAccessesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListAccessesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
listAccessesRequest - A Consumer that will call methods on
ListAccessesRequest.Builder to create a request.NextToken parameter that was passed is invalid.default CompletableFuture<ListAgreementsResponse> listAgreements(ListAgreementsRequest listAgreementsRequest)
Returns a list of the agreements for the server that's identified by the ServerId that you supply.
If you want to limit the results to a certain number, supply a value for the MaxResults parameter.
If you ran the command previously and received a value for NextToken, you can supply that value to
continue listing agreements from where you left off.
listAgreementsRequest - NextToken parameter that was passed is invalid.default CompletableFuture<ListAgreementsResponse> listAgreements(Consumer<ListAgreementsRequest.Builder> listAgreementsRequest)
Returns a list of the agreements for the server that's identified by the ServerId that you supply.
If you want to limit the results to a certain number, supply a value for 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()
listAgreementsRequest - A Consumer that will call methods on
ListAgreementsRequest.Builder to create a request.NextToken parameter that was passed is invalid.default ListAgreementsPublisher listAgreementsPaginator(ListAgreementsRequest listAgreementsRequest)
Returns a list of the agreements for the server that's identified by the ServerId that you supply.
If you want to limit the results to a certain number, supply a value for the MaxResults parameter.
If you ran the command previously and received a value for NextToken, you can supply that value to
continue listing agreements from where you left off.
This is a variant of
listAgreements(software.amazon.awssdk.services.transfer.model.ListAgreementsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListAgreementsPublisher publisher = client.listAgreementsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListAgreementsPublisher publisher = client.listAgreementsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListAgreementsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListAgreementsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listAgreementsRequest - NextToken parameter that was passed is invalid.default ListAgreementsPublisher listAgreementsPaginator(Consumer<ListAgreementsRequest.Builder> listAgreementsRequest)
Returns a list of the agreements for the server that's identified by the ServerId that you supply.
If you want to limit the results to a certain number, supply a value for 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 variant of
listAgreements(software.amazon.awssdk.services.transfer.model.ListAgreementsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListAgreementsPublisher publisher = client.listAgreementsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListAgreementsPublisher publisher = client.listAgreementsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListAgreementsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListAgreementsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
listAgreementsRequest - A Consumer that will call methods on
ListAgreementsRequest.Builder to create a request.NextToken parameter that was passed is invalid.default CompletableFuture<ListCertificatesResponse> listCertificates(ListCertificatesRequest listCertificatesRequest)
Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the
results to a certain number, supply a value for the MaxResults parameter. If you ran the command
previously and received a value for the NextToken parameter, you can supply that value to continue
listing certificates from where you left off.
listCertificatesRequest - NextToken parameter that was passed is invalid.default CompletableFuture<ListCertificatesResponse> listCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)
Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the
results to a certain number, supply a value for the MaxResults parameter. If you ran the command
previously and received a value for 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()
listCertificatesRequest - A Consumer that will call methods on
ListCertificatesRequest.Builder to create a
request.NextToken parameter that was passed is invalid.default ListCertificatesPublisher listCertificatesPaginator(ListCertificatesRequest listCertificatesRequest)
Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the
results to a certain number, supply a value for the MaxResults parameter. If you ran the command
previously and received a value for the NextToken parameter, you can supply that value to continue
listing certificates from where you left off.
This is a variant of
listCertificates(software.amazon.awssdk.services.transfer.model.ListCertificatesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListCertificatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListCertificatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listCertificatesRequest - NextToken parameter that was passed is invalid.default ListCertificatesPublisher listCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)
Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the
results to a certain number, supply a value for the MaxResults parameter. If you ran the command
previously and received a value for the NextToken parameter, you can supply that value to continue
listing certificates from where you left off.
This is a variant of
listCertificates(software.amazon.awssdk.services.transfer.model.ListCertificatesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListCertificatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListCertificatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
listCertificatesRequest - A Consumer that will call methods on
ListCertificatesRequest.Builder to create a
request.NextToken parameter that was passed is invalid.default CompletableFuture<ListConnectorsResponse> listConnectors(ListConnectorsRequest listConnectorsRequest)
Lists the connectors for the specified Region.
listConnectorsRequest - NextToken parameter that was passed is invalid.default CompletableFuture<ListConnectorsResponse> listConnectors(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest)
Lists the connectors for the specified Region.
This is a convenience which creates an instance of the ListConnectorsRequest.Builder avoiding the need to
create one manually via ListConnectorsRequest.builder()
listConnectorsRequest - A Consumer that will call methods on
ListConnectorsRequest.Builder to create a request.NextToken parameter that was passed is invalid.default ListConnectorsPublisher listConnectorsPaginator(ListConnectorsRequest listConnectorsRequest)
Lists the connectors for the specified Region.
This is a variant of
listConnectors(software.amazon.awssdk.services.transfer.model.ListConnectorsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListConnectorsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListConnectorsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listConnectorsRequest - NextToken parameter that was passed is invalid.default ListConnectorsPublisher listConnectorsPaginator(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest)
Lists the connectors for the specified Region.
This is a variant of
listConnectors(software.amazon.awssdk.services.transfer.model.ListConnectorsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListConnectorsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListConnectorsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
listConnectorsRequest - A Consumer that will call methods on
ListConnectorsRequest.Builder to create a request.NextToken parameter that was passed is invalid.default CompletableFuture<ListExecutionsResponse> listExecutions(ListExecutionsRequest listExecutionsRequest)
Lists all in-progress executions for the specified workflow.
If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound
exception.
listExecutionsRequest - NextToken parameter that was passed is invalid.default CompletableFuture<ListExecutionsResponse> listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Lists all in-progress executions for the specified workflow.
If the specified workflow ID cannot be found, ListExecutions returns 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()
listExecutionsRequest - A Consumer that will call methods on
ListExecutionsRequest.Builder to create a request.NextToken parameter that was passed is invalid.default ListExecutionsPublisher listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)
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 variant of
listExecutions(software.amazon.awssdk.services.transfer.model.ListExecutionsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listExecutionsRequest - NextToken parameter that was passed is invalid.default ListExecutionsPublisher listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
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 variant of
listExecutions(software.amazon.awssdk.services.transfer.model.ListExecutionsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
listExecutionsRequest - A Consumer that will call methods on
ListExecutionsRequest.Builder to create a request.NextToken parameter that was passed is invalid.default CompletableFuture<ListHostKeysResponse> listHostKeys(ListHostKeysRequest listHostKeysRequest)
Returns a list of host keys for the server that's specified by the ServerId parameter.
listHostKeysRequest - NextToken parameter that was passed is invalid.default CompletableFuture<ListHostKeysResponse> listHostKeys(Consumer<ListHostKeysRequest.Builder> listHostKeysRequest)
Returns a list of host keys for the server that's specified by the ServerId parameter.
This is a convenience which creates an instance of the ListHostKeysRequest.Builder avoiding the need to
create one manually via ListHostKeysRequest.builder()
listHostKeysRequest - A Consumer that will call methods on
ListHostKeysRequest.Builder to create a request.NextToken parameter that was passed is invalid.default CompletableFuture<ListProfilesResponse> listProfiles(ListProfilesRequest listProfilesRequest)
Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a
value for the MaxResults parameter. If you ran the command previously and received a value for
NextToken, you can supply that value to continue listing profiles from where you left off.
listProfilesRequest - NextToken parameter that was passed is invalid.default CompletableFuture<ListProfilesResponse> listProfiles(Consumer<ListProfilesRequest.Builder> listProfilesRequest)
Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a
value for the MaxResults parameter. If you ran the command previously and received a value 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()
listProfilesRequest - A Consumer that will call methods on
ListProfilesRequest.Builder to create a request.NextToken parameter that was passed is invalid.default ListProfilesPublisher listProfilesPaginator(ListProfilesRequest listProfilesRequest)
Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a
value for the MaxResults parameter. If you ran the command previously and received a value for
NextToken, you can supply that value to continue listing profiles from where you left off.
This is a variant of listProfiles(software.amazon.awssdk.services.transfer.model.ListProfilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListProfilesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListProfilesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listProfilesRequest - NextToken parameter that was passed is invalid.default ListProfilesPublisher listProfilesPaginator(Consumer<ListProfilesRequest.Builder> listProfilesRequest)
Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a
value for the MaxResults parameter. If you ran the command previously and received a value for
NextToken, you can supply that value to continue listing profiles from where you left off.
This is a variant of listProfiles(software.amazon.awssdk.services.transfer.model.ListProfilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListProfilesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListProfilesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
listProfilesRequest - A Consumer that will call methods on
ListProfilesRequest.Builder to create a request.NextToken parameter that was passed is invalid.default CompletableFuture<ListSecurityPoliciesResponse> listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
listSecurityPoliciesRequest - NextToken parameter that was passed is invalid.default CompletableFuture<ListSecurityPoliciesResponse> listSecurityPolicies(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
This is a convenience which creates an instance of the ListSecurityPoliciesRequest.Builder avoiding the
need to create one manually via ListSecurityPoliciesRequest.builder()
listSecurityPoliciesRequest - A Consumer that will call methods on
ListSecurityPoliciesRequest.Builder to create a
request.NextToken parameter that was passed is invalid.default ListSecurityPoliciesPublisher listSecurityPoliciesPaginator(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
This is a variant of
listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesPublisher publisher = client.listSecurityPoliciesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesPublisher publisher = client.listSecurityPoliciesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listSecurityPoliciesRequest - NextToken parameter that was passed is invalid.default ListSecurityPoliciesPublisher listSecurityPoliciesPaginator(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)
Lists the security policies that are attached to your file transfer protocol-enabled servers.
This is a variant of
listSecurityPolicies(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesPublisher publisher = client.listSecurityPoliciesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListSecurityPoliciesPublisher publisher = client.listSecurityPoliciesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListSecurityPoliciesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
listSecurityPoliciesRequest - A Consumer that will call methods on
ListSecurityPoliciesRequest.Builder to create a
request.NextToken parameter that was passed is invalid.default CompletableFuture<ListServersResponse> listServers(ListServersRequest listServersRequest)
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
listServersRequest - NextToken parameter that was passed is invalid.default CompletableFuture<ListServersResponse> listServers(Consumer<ListServersRequest.Builder> listServersRequest)
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
This is a convenience which creates an instance of the ListServersRequest.Builder avoiding the need to
create one manually via ListServersRequest.builder()
listServersRequest - A Consumer that will call methods on
ListServersRequest.Builder to create a request.NextToken parameter that was passed is invalid.default CompletableFuture<ListServersResponse> listServers()
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
NextToken parameter that was passed is invalid.default ListServersPublisher listServersPaginator()
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
This is a variant of listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListServersPublisher publisher = client.listServersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListServersPublisher publisher = client.listServersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListServersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListServersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
NextToken parameter that was passed is invalid.default ListServersPublisher listServersPaginator(ListServersRequest listServersRequest)
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
This is a variant of listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListServersPublisher publisher = client.listServersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListServersPublisher publisher = client.listServersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListServersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListServersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listServersRequest - NextToken parameter that was passed is invalid.default ListServersPublisher listServersPaginator(Consumer<ListServersRequest.Builder> listServersRequest)
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
This is a variant of listServers(software.amazon.awssdk.services.transfer.model.ListServersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListServersPublisher publisher = client.listServersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListServersPublisher publisher = client.listServersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListServersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListServersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
listServersRequest - A Consumer that will call methods on
ListServersRequest.Builder to create a request.NextToken parameter that was passed is invalid.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
listTagsForResourceRequest - NextToken parameter that was passed is invalid.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request.NextToken parameter that was passed is invalid.default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListTagsForResourceResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListTagsForResourceResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listTagsForResourceRequest - NextToken parameter that was passed is invalid.default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.transfer.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListTagsForResourceResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListTagsForResourceResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request.NextToken parameter that was passed is invalid.default CompletableFuture<ListUsersResponse> listUsers(ListUsersRequest listUsersRequest)
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
listUsersRequest - NextToken parameter that was passed is invalid.default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest - A Consumer that will call methods on
ListUsersRequest.Builder to create a request.NextToken parameter that was passed is invalid.default ListUsersPublisher listUsersPaginator(ListUsersRequest listUsersRequest)
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
This is a variant of listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListUsersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListUsersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listUsersRequest - NextToken parameter that was passed is invalid.default ListUsersPublisher listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
This is a variant of listUsers(software.amazon.awssdk.services.transfer.model.ListUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListUsersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListUsersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
listUsersRequest - A Consumer that will call methods on
ListUsersRequest.Builder to create a request.NextToken parameter that was passed is invalid.default CompletableFuture<ListWorkflowsResponse> listWorkflows(ListWorkflowsRequest listWorkflowsRequest)
Lists all workflows associated with your Amazon Web Services account for your current region.
listWorkflowsRequest - NextToken parameter that was passed is invalid.default CompletableFuture<ListWorkflowsResponse> listWorkflows(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest)
Lists all workflows associated with your Amazon Web Services account for your current region.
This is a convenience which creates an instance of the ListWorkflowsRequest.Builder avoiding the need to
create one manually via ListWorkflowsRequest.builder()
listWorkflowsRequest - A Consumer that will call methods on
ListWorkflowsRequest.Builder to create a request.NextToken parameter that was passed is invalid.default ListWorkflowsPublisher listWorkflowsPaginator(ListWorkflowsRequest listWorkflowsRequest)
Lists all workflows associated with your Amazon Web Services account for your current region.
This is a variant of listWorkflows(software.amazon.awssdk.services.transfer.model.ListWorkflowsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListWorkflowsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListWorkflowsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listWorkflowsRequest - NextToken parameter that was passed is invalid.default ListWorkflowsPublisher listWorkflowsPaginator(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest)
Lists all workflows associated with your Amazon Web Services account for your current region.
This is a variant of listWorkflows(software.amazon.awssdk.services.transfer.model.ListWorkflowsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.transfer.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.transfer.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transfer.model.ListWorkflowsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.transfer.model.ListWorkflowsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
listWorkflowsRequest - A Consumer that will call methods on
ListWorkflowsRequest.Builder to create a request.NextToken parameter that was passed is invalid.default CompletableFuture<SendWorkflowStepStateResponse> sendWorkflowStepState(SendWorkflowStepStateRequest sendWorkflowStepStateRequest)
Sends a callback for asynchronous custom steps.
The ExecutionId, WorkflowId, and Token are passed to the target resource
during execution of a custom step of a workflow. You must include those with their callback as well as providing
a status.
sendWorkflowStepStateRequest - default CompletableFuture<SendWorkflowStepStateResponse> sendWorkflowStepState(Consumer<SendWorkflowStepStateRequest.Builder> sendWorkflowStepStateRequest)
Sends a callback for asynchronous custom steps.
The ExecutionId, WorkflowId, and Token are passed to the target resource
during execution of a custom step of a workflow. You must include those with their callback as well as providing
a status.
This is a convenience which creates an instance of the SendWorkflowStepStateRequest.Builder avoiding the
need to create one manually via SendWorkflowStepStateRequest.builder()
sendWorkflowStepStateRequest - A Consumer that will call methods on
SendWorkflowStepStateRequest.Builder to create a
request.default CompletableFuture<StartFileTransferResponse> startFileTransfer(StartFileTransferRequest startFileTransferRequest)
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
For an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to
identify the files you want to transfer.
For an SFTP connector, the file transfer can be either outbound or inbound. In both cases, you specify the
ConnectorId. Depending on the direction of the transfer, you also specify the following items:
If you are transferring file from a partner's SFTP server to Amazon Web Services storage, you specify one or more
RetreiveFilePaths to identify the files you want to transfer, and a LocalDirectoryPath
to specify the destination folder.
If you are transferring file to a partner's SFTP server from Amazon Web Services storage, you specify one or more
SendFilePaths to identify the files you want to transfer, and a RemoteDirectoryPath to
specify the destination folder.
startFileTransferRequest - default CompletableFuture<StartFileTransferResponse> startFileTransfer(Consumer<StartFileTransferRequest.Builder> startFileTransferRequest)
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
For an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to
identify the files you want to transfer.
For an SFTP connector, the file transfer can be either outbound or inbound. In both cases, you specify the
ConnectorId. Depending on the direction of the transfer, you also specify the following items:
If you are transferring file from a partner's SFTP server to Amazon Web Services storage, you specify one or more
RetreiveFilePaths to identify the files you want to transfer, and a LocalDirectoryPath
to specify the destination folder.
If you are transferring file to a partner's SFTP server from Amazon Web Services storage, you specify one or more
SendFilePaths to identify the files you want to transfer, and a RemoteDirectoryPath to
specify the destination folder.
This is a convenience which creates an instance of the StartFileTransferRequest.Builder avoiding the need
to create one manually via StartFileTransferRequest.builder()
startFileTransferRequest - A Consumer that will call methods on
StartFileTransferRequest.Builder to create a
request.default CompletableFuture<StartServerResponse> startServer(StartServerRequest startServerRequest)
Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It
has no impact on a server that is already ONLINE. An ONLINE server can accept and
process file transfer jobs.
The state of STARTING indicates that the server is in an intermediate state, either not fully able
to respond, or not fully online. The values of START_FAILED can indicate an error condition.
No response is returned from this call.
startServerRequest - default CompletableFuture<StartServerResponse> startServer(Consumer<StartServerRequest.Builder> startServerRequest)
Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It
has no impact on a server that is already ONLINE. An ONLINE server can accept and
process file transfer jobs.
The state of STARTING indicates that the server is in an intermediate state, either not fully able
to respond, or not fully online. The values of START_FAILED can indicate an error condition.
No response is returned from this call.
This is a convenience which creates an instance of the StartServerRequest.Builder avoiding the need to
create one manually via StartServerRequest.builder()
startServerRequest - A Consumer that will call methods on
StartServerRequest.Builder to create a request.default CompletableFuture<StopServerResponse> stopServer(StopServerRequest stopServerRequest)
Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An
OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such
as server and user properties, are not affected by stopping your server.
Stopping the server does not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.
The state of STOPPING indicates that the server is in an intermediate state, either not fully able
to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.
No response is returned from this call.
stopServerRequest - default CompletableFuture<StopServerResponse> stopServer(Consumer<StopServerRequest.Builder> stopServerRequest)
Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An
OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such
as server and user properties, are not affected by stopping your server.
Stopping the server does not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.
The state of STOPPING indicates that the server is in an intermediate state, either not fully able
to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.
No response is returned from this call.
This is a convenience which creates an instance of the StopServerRequest.Builder avoiding the need to
create one manually via StopServerRequest.builder()
stopServerRequest - A Consumer that will call methods on
StopServerRequest.Builder to create a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
There is no response returned from this call.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
There is no response returned from this call.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.default CompletableFuture<TestConnectionResponse> testConnection(TestConnectionRequest testConnectionRequest)
Tests whether your SFTP connector is set up successfully. We highly recommend that you call this operation to test your ability to transfer files between a Transfer Family server and a trading partner's SFTP server.
testConnectionRequest - default CompletableFuture<TestConnectionResponse> testConnection(Consumer<TestConnectionRequest.Builder> testConnectionRequest)
Tests whether your SFTP connector is set up successfully. We highly recommend that you call this operation to test your ability to transfer files between a Transfer Family server 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()
testConnectionRequest - A Consumer that will call methods on
TestConnectionRequest.Builder to create a request.default CompletableFuture<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. We highly recommend that you call this operation to test your authentication method as soon as you
create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure
that your users can successfully use the service.
The ServerId and UserName parameters are required. The ServerProtocol,
SourceIp, and UserPassword are all optional.
Note the following:
You cannot use TestIdentityProvider if the IdentityProviderType of your server is
SERVICE_MANAGED.
TestIdentityProvider does not work with keys: it only accepts passwords.
TestIdentityProvider can test the password operation for a custom Identity Provider that handles
keys and passwords.
If you provide any incorrect values for any parameters, the Response field is empty.
If you provide a server ID for a server that uses service-managed users, you get an error:
An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth
If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer
server, you receive the following error:
An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server
.
It is possible your sever is in a different region. You can specify a region by adding the following:
--region region-code, such as --region us-east-2 to specify a server in US East
(Ohio).
testIdentityProviderRequest - default CompletableFuture<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. 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()
testIdentityProviderRequest - A Consumer that will call methods on
TestIdentityProviderRequest.Builder to create a
request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
No response is returned from this call.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
No response is returned from this call.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdateAccessResponse> updateAccess(UpdateAccessRequest updateAccessRequest)
Allows you to update parameters for the access specified in the ServerID and ExternalID
parameters.
updateAccessRequest - default CompletableFuture<UpdateAccessResponse> updateAccess(Consumer<UpdateAccessRequest.Builder> updateAccessRequest)
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()
updateAccessRequest - A Consumer that will call methods on
UpdateAccessRequest.Builder to create a request.default CompletableFuture<UpdateAgreementResponse> updateAgreement(UpdateAgreementRequest updateAgreementRequest)
Updates some of the parameters for an existing agreement. Provide the AgreementId and the
ServerId for the agreement that you want to update, along with the new values for the parameters to
update.
updateAgreementRequest - default CompletableFuture<UpdateAgreementResponse> updateAgreement(Consumer<UpdateAgreementRequest.Builder> updateAgreementRequest)
Updates some of the parameters for an existing agreement. Provide the AgreementId and the
ServerId for the agreement that you want to update, along with the new values for the parameters to
update.
This is a convenience which creates an instance of the UpdateAgreementRequest.Builder avoiding the need
to create one manually via UpdateAgreementRequest.builder()
updateAgreementRequest - A Consumer that will call methods on
UpdateAgreementRequest.Builder to create a request.default CompletableFuture<UpdateCertificateResponse> updateCertificate(UpdateCertificateRequest updateCertificateRequest)
Updates the active and inactive dates for a certificate.
updateCertificateRequest - default CompletableFuture<UpdateCertificateResponse> updateCertificate(Consumer<UpdateCertificateRequest.Builder> updateCertificateRequest)
Updates the active and inactive dates for a certificate.
This is a convenience which creates an instance of the UpdateCertificateRequest.Builder avoiding the need
to create one manually via UpdateCertificateRequest.builder()
updateCertificateRequest - A Consumer that will call methods on
UpdateCertificateRequest.Builder to create a
request.default CompletableFuture<UpdateConnectorResponse> updateConnector(UpdateConnectorRequest updateConnectorRequest)
Updates some of the parameters for an existing connector. Provide the ConnectorId for the connector
that you want to update, along with the new values for the parameters to update.
updateConnectorRequest - default CompletableFuture<UpdateConnectorResponse> updateConnector(Consumer<UpdateConnectorRequest.Builder> updateConnectorRequest)
Updates some of the parameters for an existing connector. Provide the ConnectorId for the connector
that you want to update, along with the new values for the parameters to update.
This is a convenience which creates an instance of the UpdateConnectorRequest.Builder avoiding the need
to create one manually via UpdateConnectorRequest.builder()
updateConnectorRequest - A Consumer that will call methods on
UpdateConnectorRequest.Builder to create a request.default CompletableFuture<UpdateHostKeyResponse> updateHostKey(UpdateHostKeyRequest updateHostKeyRequest)
Updates the description for the host key that's specified by the ServerId and HostKeyId
parameters.
updateHostKeyRequest - default CompletableFuture<UpdateHostKeyResponse> updateHostKey(Consumer<UpdateHostKeyRequest.Builder> updateHostKeyRequest)
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()
updateHostKeyRequest - A Consumer that will call methods on
UpdateHostKeyRequest.Builder to create a request.default CompletableFuture<UpdateProfileResponse> updateProfile(UpdateProfileRequest updateProfileRequest)
Updates some of the parameters for an existing profile. Provide the ProfileId for the profile that
you want to update, along with the new values for the parameters to update.
updateProfileRequest - default CompletableFuture<UpdateProfileResponse> updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest)
Updates some of the parameters for an existing profile. Provide the ProfileId for the profile that
you want to update, along with the new values for the parameters to update.
This is a convenience which creates an instance of the UpdateProfileRequest.Builder avoiding the need to
create one manually via UpdateProfileRequest.builder()
updateProfileRequest - A Consumer that will call methods on
UpdateProfileRequest.Builder to create a request.default CompletableFuture<UpdateServerResponse> updateServer(UpdateServerRequest updateServerRequest)
Updates the file transfer protocol-enabled server's properties after that server has been created.
The UpdateServer call returns the ServerId of the server you updated.
updateServerRequest - UpdateServer is called for a file
transfer protocol-enabled server that has VPC as the endpoint type and the server's
VpcEndpointID is not in the available state.default CompletableFuture<UpdateServerResponse> updateServer(Consumer<UpdateServerRequest.Builder> updateServerRequest)
Updates the file transfer protocol-enabled server's properties after that server has been created.
The UpdateServer call returns 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()
updateServerRequest - A Consumer that will call methods on
UpdateServerRequest.Builder to create a request.UpdateServer is called for a file
transfer protocol-enabled server that has VPC as the endpoint type and the server's
VpcEndpointID is not in the available state.default CompletableFuture<UpdateUserResponse> updateUser(UpdateUserRequest updateUserRequest)
Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory,
role, and policy for the UserName and ServerId you specify.
The response returns the ServerId and the UserName for the updated user.
updateUserRequest - default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory,
role, and policy for the UserName and ServerId you specify.
The response returns the ServerId and the UserName for the updated user.
This is a convenience which creates an instance of the UpdateUserRequest.Builder avoiding the need to
create one manually via UpdateUserRequest.builder()
updateUserRequest - A Consumer that will call methods on
UpdateUserRequest.Builder to create a request.default TransferAsyncWaiter waiter()
TransferAsyncWaiter using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
TransferAsyncWaiterdefault TransferServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic TransferAsyncClient create()
TransferAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static TransferAsyncClientBuilder builder()
TransferAsyncClient.Copyright © 2023. All rights reserved.