amazonaws.com – transfer

OpenAPI apis-guru cloud

Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS. Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3. Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with Amazon Web Services for processing, analytics, machine learning, and archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and set up.

Homepage: https://api.apis.guru/v2/specs/amazonaws.com:transfer/2018-11-05.json
Provider: amazonaws.com:transfer / transfer
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/amazonaws.com/transfer/2018-11-05/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/amazonaws.com/transfer/2018-11-05/openapi.yaml

Tools (60)

Extracted live via the executor SDK.

xAmzTargetTransferServiceCreateAccess.createAccess

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.
xAmzTargetTransferServiceCreateAgreement.createAgreement

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.
xAmzTargetTransferServiceCreateConnector.createConnector

Creates the connector, which captures the parameters for an outbound connection for the AS2 protocol. The connector is required for sending files to an externally hosted AS2 server. For more details about connectors, see .
xAmzTargetTransferServiceCreateProfile.createProfile

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

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.
xAmzTargetTransferServiceCreateUser.createUser

Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set 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.
xAmzTargetTransferServiceCreateWorkflow.createWorkflow

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.
xAmzTargetTransferServiceDeleteAccess.deleteAccess

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

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

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

Deletes the agreement that's specified in the provided ConnectorId.
xAmzTargetTransferServiceDeleteHostKey.deleteHostKey

Deletes the host key that's specified in the HoskKeyId parameter.
xAmzTargetTransferServiceDeleteProfile.deleteProfile

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

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

No response returns from this operation.
xAmzTargetTransferServiceDeleteSshPublicKey.deleteSshPublicKey

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

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

No response returns from this operation.

When you delete a user from a server, the user's information is lost.
xAmzTargetTransferServiceDeleteWorkflow.deleteWorkflow

Deletes the specified workflow.
xAmzTargetTransferServiceDescribeAccess.describeAccess

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.
xAmzTargetTransferServiceDescribeAgreement.describeAgreement

Describes the agreement that's identified by the AgreementId.
xAmzTargetTransferServiceDescribeCertificate.describeCertificate

Describes the certificate that's identified by the CertificateId.
xAmzTargetTransferServiceDescribeConnector.describeConnector

Describes the connector that's identified by the ConnectorId.
xAmzTargetTransferServiceDescribeExecution.describeExecution

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

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

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

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 .
xAmzTargetTransferServiceDescribeServer.describeServer

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.
xAmzTargetTransferServiceDescribeUser.describeUser

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.
xAmzTargetTransferServiceDescribeWorkflow.describeWorkflow

Describes the specified workflow.
xAmzTargetTransferServiceImportCertificate.importCertificate

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

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

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.
xAmzTargetTransferServiceListAccesses.listAccesses

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

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.
xAmzTargetTransferServiceListCertificates.listCertificates

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.
xAmzTargetTransferServiceListConnectors.listConnectors

Lists the connectors for the specified Region.
xAmzTargetTransferServiceListExecutions.listExecutions

Lists all executions for the specified workflow.
xAmzTargetTransferServiceListHostKeys.listHostKeys

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

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.
xAmzTargetTransferServiceListSecurityPolicies.listSecurityPolicies

Lists the security policies that are attached to your file transfer protocol-enabled servers.
xAmzTargetTransferServiceListServers.listServers

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

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
xAmzTargetTransferServiceListUsers.listUsers

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

Lists all of your workflows.
xAmzTargetTransferServiceSendWorkflowStepState.sendWorkflowStepState

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.
xAmzTargetTransferServiceStartFileTransfer.startFileTransfer

Begins an outbound file transfer to a remote AS2 server. You specify the ConnectorId and the file paths for where to send the files.
xAmzTargetTransferServiceStartServer.startServer

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.
xAmzTargetTransferServiceStopServer.stopServer

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.
xAmzTargetTransferServiceTagResource.tagResource

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

There is no response returned from this call.
xAmzTargetTransferServiceTestIdentityProvider.testIdentityProvider
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
xAmzTargetTransferServiceUntagResource.untagResource

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.
xAmzTargetTransferServiceUpdateAccess.updateAccess

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

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.
xAmzTargetTransferServiceUpdateCertificate.updateCertificate

Updates the active and inactive dates for a certificate.
xAmzTargetTransferServiceUpdateConnector.updateConnector

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.
xAmzTargetTransferServiceUpdateHostKey.updateHostKey

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

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.
xAmzTargetTransferServiceUpdateServer.updateServer

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.
xAmzTargetTransferServiceUpdateUser.updateUser

Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify.

The response returns the ServerId and the UserName for the updated user.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools