@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface TransferAsyncClient extends SdkClient
builder()
method.
Amazon Web Services 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). Amazon Web Services helps you seamlessly migrate your file transfer workflows to Amazon Web Services Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning, and archiving. Getting started with Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services Transfer Family.
|
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<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<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<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<ImportSshPublicKeyResponse> |
importSshPublicKey(Consumer<ImportSshPublicKeyRequest.Builder> importSshPublicKeyRequest)
Adds a Secure Shell (SSH) public key to a user account 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 user account 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<ListExecutionsResponse> |
listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Lists all executions for the specified workflow.
|
default CompletableFuture<ListExecutionsResponse> |
listExecutions(ListExecutionsRequest listExecutionsRequest)
Lists all executions for the specified workflow.
|
default ListExecutionsPublisher |
listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Lists all executions for the specified workflow.
|
default ListExecutionsPublisher |
listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)
Lists all executions for the specified workflow.
|
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 of your workflows.
|
default CompletableFuture<ListWorkflowsResponse> |
listWorkflows(ListWorkflowsRequest listWorkflowsRequest)
Lists all of your workflows.
|
default ListWorkflowsPublisher |
listWorkflowsPaginator(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest)
Lists all of your workflows.
|
default ListWorkflowsPublisher |
listWorkflowsPaginator(ListWorkflowsRequest listWorkflowsRequest)
Lists all of your workflows.
|
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 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<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<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.static TransferAsyncClient create()
TransferAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static TransferAsyncClientBuilder builder()
TransferAsyncClient.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 Amazon Web Services 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 Amazon Web Services 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<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 - HTTP Status Code: 400
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.HTTP Status Code: 400
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 Amazon Web Services 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 Amazon Web Services 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 - HTTP Status Code: 400
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.HTTP Status Code: 400
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<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 - HTTP Status Code: 400
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.HTTP Status Code: 400
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<DescribeExecutionResponse> describeExecution(DescribeExecutionRequest describeExecutionRequest)
You can use DescribeExecution to check the details of the execution of the specified workflow.
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 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<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<ImportSshPublicKeyResponse> importSshPublicKey(ImportSshPublicKeyRequest importSshPublicKeyRequest)
Adds a Secure Shell (SSH) public key to a user account 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 - HTTP Status Code: 400
default CompletableFuture<ImportSshPublicKeyResponse> importSshPublicKey(Consumer<ImportSshPublicKeyRequest.Builder> importSshPublicKeyRequest)
Adds a Secure Shell (SSH) public key to a user account 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.HTTP Status Code: 400
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<ListExecutionsResponse> listExecutions(ListExecutionsRequest listExecutionsRequest)
Lists all executions for the specified workflow.
listExecutionsRequest - NextToken parameter that was passed is invalid.default CompletableFuture<ListExecutionsResponse> listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Lists all executions for the specified workflow.
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 executions for the specified workflow.
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 executions for the specified workflow.
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<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 of your workflows.
listWorkflowsRequest - NextToken parameter that was passed is invalid.default CompletableFuture<ListWorkflowsResponse> listWorkflows(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest)
Lists all of your workflows.
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 of your workflows.
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 of your workflows.
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 - HTTP Status Code: 400
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.HTTP Status Code: 400
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 - HTTP Status Code: 400
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.HTTP Status Code: 400
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 will 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 - HTTP Status Code: 400
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 will 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.HTTP Status Code: 400
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<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.
You cannot use TestIdentityProvider if the IdentityProviderType of your server is
SERVICE_MANAGED.
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
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.
You cannot use TestIdentityProvider if the IdentityProviderType of your server is
SERVICE_MANAGED.
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
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<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.HTTP Status Code: 400
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.HTTP Status Code: 400
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 - HTTP Status Code: 400
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.HTTP Status Code: 400
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.
TransferAsyncWaiterCopyright © 2022. All rights reserved.