AbstractAWSTransfer (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.transfer.AbstractAWSTransfer

All Implemented Interfaces:

AWSTransfer

Direct Known Subclasses:

AbstractAWSTransferAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSTransfer
extends Object
implements AWSTransfer
```
Abstract implementation of AWSTransfer. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.transfer.AWSTransfer
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateAccessResult`	`createAccess(CreateAccessRequest request)` Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Transfer Family.
`CreateAgreementResult`	`createAgreement(CreateAgreementRequest request)` Creates an agreement.
`CreateConnectorResult`	`createConnector(CreateConnectorRequest request)` Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.
`CreateProfileResult`	`createProfile(CreateProfileRequest request)` Creates the local or partner profile to use for AS2 transfers.
`CreateServerResult`	`createServer(CreateServerRequest request)` Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.
`CreateUserResult`	`createUser(CreateUserRequest request)` Creates a user and associates them with an existing file transfer protocol-enabled server.
`CreateWorkflowResult`	`createWorkflow(CreateWorkflowRequest request)` Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.
`DeleteAccessResult`	`deleteAccess(DeleteAccessRequest request)` Allows you to delete the access specified in the `ServerID` and `ExternalID` parameters.
`DeleteAgreementResult`	`deleteAgreement(DeleteAgreementRequest request)` Delete the agreement that's specified in the provided `AgreementId`.
`DeleteCertificateResult`	`deleteCertificate(DeleteCertificateRequest request)` Deletes the certificate that's specified in the `CertificateId` parameter.
`DeleteConnectorResult`	`deleteConnector(DeleteConnectorRequest request)` Deletes the connector that's specified in the provided `ConnectorId`.
`DeleteHostKeyResult`	`deleteHostKey(DeleteHostKeyRequest request)` Deletes the host key that's specified in the `HostKeyId` parameter.
`DeleteProfileResult`	`deleteProfile(DeleteProfileRequest request)` Deletes the profile that's specified in the `ProfileId` parameter.
`DeleteServerResult`	`deleteServer(DeleteServerRequest request)` Deletes the file transfer protocol-enabled server that you specify.
`DeleteSshPublicKeyResult`	`deleteSshPublicKey(DeleteSshPublicKeyRequest request)` Deletes a user's Secure Shell (SSH) public key.
`DeleteUserResult`	`deleteUser(DeleteUserRequest request)` Deletes the user belonging to a file transfer protocol-enabled server you specify.
`DeleteWorkflowResult`	`deleteWorkflow(DeleteWorkflowRequest request)` Deletes the specified workflow.
`DescribeAccessResult`	`describeAccess(DescribeAccessRequest request)` Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its `ServerId` property and its `ExternalId`.
`DescribeAgreementResult`	`describeAgreement(DescribeAgreementRequest request)` Describes the agreement that's identified by the `AgreementId`.
`DescribeCertificateResult`	`describeCertificate(DescribeCertificateRequest request)` Describes the certificate that's identified by the `CertificateId`.
`DescribeConnectorResult`	`describeConnector(DescribeConnectorRequest request)` Describes the connector that's identified by the `ConnectorId.`
`DescribeExecutionResult`	`describeExecution(DescribeExecutionRequest request)` You can use `DescribeExecution` to check the details of the execution of the specified workflow.
`DescribeHostKeyResult`	`describeHostKey(DescribeHostKeyRequest request)` Returns the details of the host key that's specified by the `HostKeyId` and `ServerId`.
`DescribeProfileResult`	`describeProfile(DescribeProfileRequest request)` Returns the details of the profile that's specified by the `ProfileId`.
`DescribeSecurityPolicyResult`	`describeSecurityPolicy(DescribeSecurityPolicyRequest request)` Describes the security policy that is attached to your server or SFTP connector.
`DescribeServerResult`	`describeServer(DescribeServerRequest request)` Describes a file transfer protocol-enabled server that you specify by passing the `ServerId` parameter.
`DescribeUserResult`	`describeUser(DescribeUserRequest request)` Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its `ServerId` property.
`DescribeWorkflowResult`	`describeWorkflow(DescribeWorkflowRequest request)` Describes the specified workflow.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ImportCertificateResult`	`importCertificate(ImportCertificateRequest request)` Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.
`ImportHostKeyResult`	`importHostKey(ImportHostKeyRequest request)` Adds a host key to the server that's specified by the `ServerId` parameter.
`ImportSshPublicKeyResult`	`importSshPublicKey(ImportSshPublicKeyRequest request)` Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a `UserName` value assigned to the specific file transfer protocol-enabled server, identified by `ServerId`.
`ListAccessesResult`	`listAccesses(ListAccessesRequest request)` Lists the details for all the accesses you have on your server.
`ListAgreementsResult`	`listAgreements(ListAgreementsRequest request)` Returns a list of the agreements for the server that's identified by the `ServerId` that you supply.
`ListCertificatesResult`	`listCertificates(ListCertificatesRequest request)` Returns a list of the current certificates that have been imported into Transfer Family.
`ListConnectorsResult`	`listConnectors(ListConnectorsRequest request)` Lists the connectors for the specified Region.
`ListExecutionsResult`	`listExecutions(ListExecutionsRequest request)` Lists all in-progress executions for the specified workflow.
`ListHostKeysResult`	`listHostKeys(ListHostKeysRequest request)` Returns a list of host keys for the server that's specified by the `ServerId` parameter.
`ListProfilesResult`	`listProfiles(ListProfilesRequest request)` Returns a list of the profiles for your system.
`ListSecurityPoliciesResult`	`listSecurityPolicies(ListSecurityPoliciesRequest request)` Lists the security policies that are attached to your servers and SFTP connectors.
`ListServersResult`	`listServers(ListServersRequest request)` Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
`ListUsersResult`	`listUsers(ListUsersRequest request)` Lists the users for a file transfer protocol-enabled server that you specify by passing the `ServerId` parameter.
`ListWorkflowsResult`	`listWorkflows(ListWorkflowsRequest request)` Lists all workflows associated with your Amazon Web Services account for your current region.
`SendWorkflowStepStateResult`	`sendWorkflowStepState(SendWorkflowStepStateRequest request)` Sends a callback for asynchronous custom steps.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartDirectoryListingResult`	`startDirectoryListing(StartDirectoryListingRequest request)` Retrieves a list of the contents of a directory from a remote SFTP server.
`StartFileTransferResult`	`startFileTransfer(StartFileTransferRequest request)` Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
`StartServerResult`	`startServer(StartServerRequest request)` Changes the state of a file transfer protocol-enabled server from `OFFLINE` to `ONLINE`.
`StopServerResult`	`stopServer(StopServerRequest request)` Changes the state of a file transfer protocol-enabled server from `ONLINE` to `OFFLINE`.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
`TestConnectionResult`	`testConnection(TestConnectionRequest request)` Tests whether your SFTP connector is set up successfully.
`TestIdentityProviderResult`	`testIdentityProvider(TestIdentityProviderRequest request)` If the `IdentityProviderType` of a file transfer protocol-enabled server is `AWS_DIRECTORY_SERVICE` or `API_Gateway`, tests whether your identity provider is set up successfully.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
`UpdateAccessResult`	`updateAccess(UpdateAccessRequest request)` Allows you to update parameters for the access specified in the `ServerID` and `ExternalID` parameters.
`UpdateAgreementResult`	`updateAgreement(UpdateAgreementRequest request)` Updates some of the parameters for an existing agreement.
`UpdateCertificateResult`	`updateCertificate(UpdateCertificateRequest request)` Updates the active and inactive dates for a certificate.
`UpdateConnectorResult`	`updateConnector(UpdateConnectorRequest request)` Updates some of the parameters for an existing connector.
`UpdateHostKeyResult`	`updateHostKey(UpdateHostKeyRequest request)` Updates the description for the host key that's specified by the `ServerId` and `HostKeyId` parameters.
`UpdateProfileResult`	`updateProfile(UpdateProfileRequest request)` Updates some of the parameters for an existing profile.
`UpdateServerResult`	`updateServer(UpdateServerRequest request)` Updates the file transfer protocol-enabled server's properties after that server has been created.
`UpdateUserResult`	`updateUser(UpdateUserRequest request)` Assigns new properties to a user.
`AWSTransferWaiters`	`waiters()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createAccess
```
public CreateAccessResult createAccess(CreateAccessRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    createAccess in interface AWSTransfer
    
    Returns:
    
    Result of the CreateAccess operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAgreement
```
public CreateAgreementResult createAgreement(CreateAgreementRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    createAgreement in interface AWSTransfer
    
    Returns:
    
    Result of the CreateAgreement operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createConnector
```
public CreateConnectorResult createConnector(CreateConnectorRequest request)
```
    Description copied from interface: AWSTransfer
    
    Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server. For more details about connectors, see Configure AS2 connectors and Create SFTP connectors.
    
    You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP ( SftpConfig).
    
    Specified by:
    
    createConnector in interface AWSTransfer
    
    Returns:
    
    Result of the CreateConnector operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createProfile
```
public CreateProfileResult createProfile(CreateProfileRequest request)
```
    Description copied from interface: AWSTransfer
    
    Creates the local or partner profile to use for AS2 transfers.
    
    Specified by:
    
    createProfile in interface AWSTransfer
    
    Returns:
    
    Result of the CreateProfile operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createServer
```
public CreateServerResult createServer(CreateServerRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    createServer in interface AWSTransfer
    
    Returns:
    
    Result of the CreateServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createUser
```
public CreateUserResult createUser(CreateUserRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    createUser in interface AWSTransfer
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createWorkflow
```
public CreateWorkflowResult createWorkflow(CreateWorkflowRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    createWorkflow in interface AWSTransfer
    
    Returns:
    
    Result of the CreateWorkflow operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAccess
```
public DeleteAccessResult deleteAccess(DeleteAccessRequest request)
```
    Description copied from interface: AWSTransfer
    
    Allows you to delete the access specified in the ServerID and ExternalID parameters.
    
    Specified by:
    
    deleteAccess in interface AWSTransfer
    
    Returns:
    
    Result of the DeleteAccess operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAgreement
```
public DeleteAgreementResult deleteAgreement(DeleteAgreementRequest request)
```
    Description copied from interface: AWSTransfer
    
    Delete the agreement that's specified in the provided AgreementId.
    
    Specified by:
    
    deleteAgreement in interface AWSTransfer
    
    Returns:
    
    Result of the DeleteAgreement operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteCertificate
```
public DeleteCertificateResult deleteCertificate(DeleteCertificateRequest request)
```
    Description copied from interface: AWSTransfer
    
    Deletes the certificate that's specified in the CertificateId parameter.
    
    Specified by:
    
    deleteCertificate in interface AWSTransfer
    
    Returns:
    
    Result of the DeleteCertificate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteConnector
```
public DeleteConnectorResult deleteConnector(DeleteConnectorRequest request)
```
    Description copied from interface: AWSTransfer
    
    Deletes the connector that's specified in the provided ConnectorId.
    
    Specified by:
    
    deleteConnector in interface AWSTransfer
    
    Returns:
    
    Result of the DeleteConnector operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteHostKey
```
public DeleteHostKeyResult deleteHostKey(DeleteHostKeyRequest request)
```
    Description copied from interface: AWSTransfer
    
    Deletes the host key that's specified in the HostKeyId parameter.
    
    Specified by:
    
    deleteHostKey in interface AWSTransfer
    
    Returns:
    
    Result of the DeleteHostKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteProfile
```
public DeleteProfileResult deleteProfile(DeleteProfileRequest request)
```
    Description copied from interface: AWSTransfer
    
    Deletes the profile that's specified in the ProfileId parameter.
    
    Specified by:
    
    deleteProfile in interface AWSTransfer
    
    Returns:
    
    Result of the DeleteProfile operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteServer
```
public DeleteServerResult deleteServer(DeleteServerRequest request)
```
    Description copied from interface: AWSTransfer
    
    Deletes the file transfer protocol-enabled server that you specify.
    
    No response returns from this operation.
    
    Specified by:
    
    deleteServer in interface AWSTransfer
    
    Returns:
    
    Result of the DeleteServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteSshPublicKey
```
public DeleteSshPublicKeyResult deleteSshPublicKey(DeleteSshPublicKeyRequest request)
```
    Description copied from interface: AWSTransfer
    
    Deletes a user's Secure Shell (SSH) public key.
    
    Specified by:
    
    deleteSshPublicKey in interface AWSTransfer
    
    Returns:
    
    Result of the DeleteSshPublicKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
public DeleteUserResult deleteUser(DeleteUserRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    deleteUser in interface AWSTransfer
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteWorkflow
```
public DeleteWorkflowResult deleteWorkflow(DeleteWorkflowRequest request)
```
    Description copied from interface: AWSTransfer
    
    Deletes the specified workflow.
    
    Specified by:
    
    deleteWorkflow in interface AWSTransfer
    
    Returns:
    
    Result of the DeleteWorkflow operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAccess
```
public DescribeAccessResult describeAccess(DescribeAccessRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    describeAccess in interface AWSTransfer
    
    Returns:
    
    Result of the DescribeAccess operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAgreement
```
public DescribeAgreementResult describeAgreement(DescribeAgreementRequest request)
```
    Description copied from interface: AWSTransfer
    
    Describes the agreement that's identified by the AgreementId.
    
    Specified by:
    
    describeAgreement in interface AWSTransfer
    
    Returns:
    
    Result of the DescribeAgreement operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeCertificate
```
public DescribeCertificateResult describeCertificate(DescribeCertificateRequest request)
```
    Description copied from interface: AWSTransfer
    
    Describes the certificate that's identified by the CertificateId.
    
    Specified by:
    
    describeCertificate in interface AWSTransfer
    
    Returns:
    
    Result of the DescribeCertificate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeConnector
```
public DescribeConnectorResult describeConnector(DescribeConnectorRequest request)
```
    Description copied from interface: AWSTransfer
    
    Describes the connector that's identified by the ConnectorId.
    
    Specified by:
    
    describeConnector in interface AWSTransfer
    
    Returns:
    
    Result of the DescribeConnector operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeExecution
```
public DescribeExecutionResult describeExecution(DescribeExecutionRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    describeExecution in interface AWSTransfer
    
    Returns:
    
    Result of the DescribeExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeHostKey
```
public DescribeHostKeyResult describeHostKey(DescribeHostKeyRequest request)
```
    Description copied from interface: AWSTransfer
    
    Returns the details of the host key that's specified by the HostKeyId and ServerId.
    
    Specified by:
    
    describeHostKey in interface AWSTransfer
    
    Returns:
    
    Result of the DescribeHostKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeProfile
```
public DescribeProfileResult describeProfile(DescribeProfileRequest request)
```
    Description copied from interface: AWSTransfer
    
    Returns the details of the profile that's specified by the ProfileId.
    
    Specified by:
    
    describeProfile in interface AWSTransfer
    
    Returns:
    
    Result of the DescribeProfile operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeSecurityPolicy
```
public DescribeSecurityPolicyResult describeSecurityPolicy(DescribeSecurityPolicyRequest request)
```
    Description copied from interface: AWSTransfer
    
    Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.
    
    Specified by:
    
    describeSecurityPolicy in interface AWSTransfer
    
    Returns:
    
    Result of the DescribeSecurityPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeServer
```
public DescribeServerResult describeServer(DescribeServerRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    describeServer in interface AWSTransfer
    
    Returns:
    
    Result of the DescribeServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeUser
```
public DescribeUserResult describeUser(DescribeUserRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    describeUser in interface AWSTransfer
    
    Returns:
    
    Result of the DescribeUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeWorkflow
```
public DescribeWorkflowResult describeWorkflow(DescribeWorkflowRequest request)
```
    Description copied from interface: AWSTransfer
    
    Describes the specified workflow.
    
    Specified by:
    
    describeWorkflow in interface AWSTransfer
    
    Returns:
    
    Result of the DescribeWorkflow operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importCertificate
```
public ImportCertificateResult importCertificate(ImportCertificateRequest request)
```
    Description copied from interface: AWSTransfer
    
    Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.
    
    Specified by:
    
    importCertificate in interface AWSTransfer
    
    Returns:
    
    Result of the ImportCertificate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importHostKey
```
public ImportHostKeyResult importHostKey(ImportHostKeyRequest request)
```
    Description copied from interface: AWSTransfer
    
    Adds a host key to the server that's specified by the ServerId parameter.
    
    Specified by:
    
    importHostKey in interface AWSTransfer
    
    Returns:
    
    Result of the ImportHostKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importSshPublicKey
```
public ImportSshPublicKeyResult importSshPublicKey(ImportSshPublicKeyRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    importSshPublicKey in interface AWSTransfer
    
    Returns:
    
    Result of the ImportSshPublicKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAccesses
```
public ListAccessesResult listAccesses(ListAccessesRequest request)
```
    Description copied from interface: AWSTransfer
    
    Lists the details for all the accesses you have on your server.
    
    Specified by:
    
    listAccesses in interface AWSTransfer
    
    Returns:
    
    Result of the ListAccesses operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAgreements
```
public ListAgreementsResult listAgreements(ListAgreementsRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    listAgreements in interface AWSTransfer
    
    Returns:
    
    Result of the ListAgreements operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listCertificates
```
public ListCertificatesResult listCertificates(ListCertificatesRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    listCertificates in interface AWSTransfer
    
    Returns:
    
    Result of the ListCertificates operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listConnectors
```
public ListConnectorsResult listConnectors(ListConnectorsRequest request)
```
    Description copied from interface: AWSTransfer
    
    Lists the connectors for the specified Region.
    
    Specified by:
    
    listConnectors in interface AWSTransfer
    
    Returns:
    
    Result of the ListConnectors operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listExecutions
```
public ListExecutionsResult listExecutions(ListExecutionsRequest request)
```
    Description copied from interface: AWSTransfer
    
    Lists all in-progress executions for the specified workflow.
    
    If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.
    
    Specified by:
    
    listExecutions in interface AWSTransfer
    
    Returns:
    
    Result of the ListExecutions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listHostKeys
```
public ListHostKeysResult listHostKeys(ListHostKeysRequest request)
```
    Description copied from interface: AWSTransfer
    
    Returns a list of host keys for the server that's specified by the ServerId parameter.
    
    Specified by:
    
    listHostKeys in interface AWSTransfer
    
    Returns:
    
    Result of the ListHostKeys operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listProfiles
```
public ListProfilesResult listProfiles(ListProfilesRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    listProfiles in interface AWSTransfer
    
    Returns:
    
    Result of the ListProfiles operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSecurityPolicies
```
public ListSecurityPoliciesResult listSecurityPolicies(ListSecurityPoliciesRequest request)
```
    Description copied from interface: AWSTransfer
    
    Lists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.
    
    Specified by:
    
    listSecurityPolicies in interface AWSTransfer
    
    Returns:
    
    Result of the ListSecurityPolicies operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listServers
```
public ListServersResult listServers(ListServersRequest request)
```
    Description copied from interface: AWSTransfer
    
    Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
    
    Specified by:
    
    listServers in interface AWSTransfer
    
    Returns:
    
    Result of the ListServers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSTransfer
    
    Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
    
    Specified by:
    
    listTagsForResource in interface AWSTransfer
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUsers
```
public ListUsersResult listUsers(ListUsersRequest request)
```
    Description copied from interface: AWSTransfer
    
    Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
    
    Specified by:
    
    listUsers in interface AWSTransfer
    
    Returns:
    
    Result of the ListUsers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listWorkflows
```
public ListWorkflowsResult listWorkflows(ListWorkflowsRequest request)
```
    Description copied from interface: AWSTransfer
    
    Lists all workflows associated with your Amazon Web Services account for your current region.
    
    Specified by:
    
    listWorkflows in interface AWSTransfer
    
    Returns:
    
    Result of the ListWorkflows operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - sendWorkflowStepState
```
public SendWorkflowStepStateResult sendWorkflowStepState(SendWorkflowStepStateRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    sendWorkflowStepState in interface AWSTransfer
    
    Returns:
    
    Result of the SendWorkflowStepState operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startDirectoryListing
```
public StartDirectoryListingResult startDirectoryListing(StartDirectoryListingRequest request)
```
    Description copied from interface: AWSTransfer
    Retrieves a list of the contents of a directory from a remote SFTP server. You specify the connector ID, the output path, and the remote directory path. You can also specify the optional MaxItems value to control the maximum number of items that are listed from the remote directory. This API returns a list of all files and directories in the remote directory (up to the maximum value), but does not return files or folders in sub-directories. That is, it only returns a list of files and directories one-level deep.
    
    After you receive the listing file, you can provide the files that you want to transfer to the RetrieveFilePaths parameter of the StartFileTransfer API call.
    
    The naming convention for the output file is connector-ID-listing-ID.json. The output file contains the following information:
    - filePath: the complete path of a remote file, relative to the directory of the listing request for your SFTP connector on the remote server.
    - modifiedTimestamp: the last time the file was modified, in UTC time format. This field is optional. If the remote file attributes don't contain a timestamp, it is omitted from the file listing.
    - size: the size of the file, in bytes. This field is optional. If the remote file attributes don't contain a file size, it is omitted from the file listing.
    - path: the complete path of a remote directory, relative to the directory of the listing request for your SFTP connector on the remote server.
    - truncated: a flag indicating whether the list output contains all of the items contained in the remote directory or not. If your Truncated output value is true, you can increase the value provided in the optional max-items input attribute to be able to list more items (up to the maximum allowed list size of 10,000 items).
    Specified by:
    
    startDirectoryListing in interface AWSTransfer
    
    Returns:
    
    Result of the StartDirectoryListing operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startFileTransfer
```
public StartFileTransferResult startFileTransfer(StartFileTransferRequest request)
```
    Description copied from interface: AWSTransfer
    Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
    - For an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files you want to transfer.
    - For an SFTP connector, the file transfer can be either outbound or inbound. In both cases, you specify the ConnectorId. Depending on the direction of the transfer, you also specify the following items:
      
      If you are transferring file from a partner's SFTP server to Amazon Web Services storage, you specify one or more RetrieveFilePaths to identify the files you want to transfer, and a LocalDirectoryPath to specify the destination folder.
      
      If you are transferring file to a partner's SFTP server from Amazon Web Services storage, you specify one or more SendFilePaths to identify the files you want to transfer, and a RemoteDirectoryPath to specify the destination folder.
    Specified by:
    
    startFileTransfer in interface AWSTransfer
    
    Returns:
    
    Result of the StartFileTransfer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startServer
```
public StartServerResult startServer(StartServerRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    startServer in interface AWSTransfer
    
    Returns:
    
    Result of the StartServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopServer
```
public StopServerResult stopServer(StopServerRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    stopServer in interface AWSTransfer
    
    Returns:
    
    Result of the StopServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    tagResource in interface AWSTransfer
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - testConnection
```
public TestConnectionResult testConnection(TestConnectionRequest request)
```
    Description copied from interface: AWSTransfer
    
    Tests whether your SFTP connector is set up successfully. We highly recommend that you call this operation to test your ability to transfer files between local Amazon Web Services storage and a trading partner's SFTP server.
    
    Specified by:
    
    testConnection in interface AWSTransfer
    
    Returns:
    
    Result of the TestConnection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - testIdentityProvider
```
public TestIdentityProviderResult testIdentityProvider(TestIdentityProviderRequest request)
```
    Description copied from interface: AWSTransfer
    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).
    Specified by:
    
    testIdentityProvider in interface AWSTransfer
    
    Returns:
    
    Result of the TestIdentityProvider operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    untagResource in interface AWSTransfer
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAccess
```
public UpdateAccessResult updateAccess(UpdateAccessRequest request)
```
    Description copied from interface: AWSTransfer
    
    Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.
    
    Specified by:
    
    updateAccess in interface AWSTransfer
    
    Returns:
    
    Result of the UpdateAccess operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAgreement
```
public UpdateAgreementResult updateAgreement(UpdateAgreementRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    updateAgreement in interface AWSTransfer
    
    Returns:
    
    Result of the UpdateAgreement operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateCertificate
```
public UpdateCertificateResult updateCertificate(UpdateCertificateRequest request)
```
    Description copied from interface: AWSTransfer
    
    Updates the active and inactive dates for a certificate.
    
    Specified by:
    
    updateCertificate in interface AWSTransfer
    
    Returns:
    
    Result of the UpdateCertificate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateConnector
```
public UpdateConnectorResult updateConnector(UpdateConnectorRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    updateConnector in interface AWSTransfer
    
    Returns:
    
    Result of the UpdateConnector operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateHostKey
```
public UpdateHostKeyResult updateHostKey(UpdateHostKeyRequest request)
```
    Description copied from interface: AWSTransfer
    
    Updates the description for the host key that's specified by the ServerId and HostKeyId parameters.
    
    Specified by:
    
    updateHostKey in interface AWSTransfer
    
    Returns:
    
    Result of the UpdateHostKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateProfile
```
public UpdateProfileResult updateProfile(UpdateProfileRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    updateProfile in interface AWSTransfer
    
    Returns:
    
    Result of the UpdateProfile operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateServer
```
public UpdateServerResult updateServer(UpdateServerRequest request)
```
    Description copied from interface: AWSTransfer
    
    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.
    
    Specified by:
    
    updateServer in interface AWSTransfer
    
    Returns:
    
    Result of the UpdateServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateUser
```
public UpdateUserResult updateUser(UpdateUserRequest request)
```
    Description copied from interface: AWSTransfer
    
    Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify.
    
    The response returns the ServerId and the UserName for the updated user.
    
    In the console, you can select Restricted when you create or update a user. This ensures that the user can't access anything outside of their home directory. The programmatic way to configure this behavior is to update the user. Set their HomeDirectoryType to LOGICAL, and specify HomeDirectoryMappings with Entry as root (/) and Target as their home directory.
    
    For example, if the user's home directory is /test/admin-user, the following command updates the user so that their configuration in the console shows the Restricted flag as selected.
    
    aws transfer update-user --server-id <server-id> --user-name admin-user --home-directory-type LOGICAL --home-directory-mappings "[{\"Entry\":\"/\", \"Target\":\"/test/admin-user\"}]"
    
    Specified by:
    
    updateUser in interface AWSTransfer
    
    Returns:
    
    Result of the UpdateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSTransfer
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSTransfer
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSTransfer
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSTransfer
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
public AWSTransferWaiters waiters()
```
    Specified by:
    
    waiters in interface AWSTransfer

AWS SDK for Java 1.x API Reference - 1.12.773

Class AbstractAWSTransfer

Field Summary

Fields inherited from interface com.amazonaws.services.transfer.AWSTransfer

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createAccess

createAgreement

createConnector

createProfile

createServer

createUser

createWorkflow

deleteAccess

deleteAgreement

deleteCertificate

deleteConnector

deleteHostKey

deleteProfile

deleteServer

deleteSshPublicKey

deleteUser

deleteWorkflow

describeAccess

describeAgreement

describeCertificate

describeConnector

describeExecution

describeHostKey

describeProfile

describeSecurityPolicy

describeServer

describeUser

describeWorkflow

importCertificate

importHostKey

importSshPublicKey

listAccesses

listAgreements

listCertificates

listConnectors

listExecutions

listHostKeys

listProfiles

listSecurityPolicies

listServers

listTagsForResource

listUsers

listWorkflows

sendWorkflowStepState

startDirectoryListing

startFileTransfer

startServer

stopServer

tagResource

testConnection

testIdentityProvider

untagResource

updateAccess

updateAgreement

updateCertificate

updateConnector

updateHostKey

updateProfile

updateServer

updateUser

shutdown

getCachedResponseMetadata

waiters