# AWS Transfer Family API

> AWS Transfer Family API on Apizie: 59 endpoints (Used by administrators to choose which groups in the directory should have access to upload and download…, Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an…, Creates the connector, which captures the parameters for an outbound connection for the AS2 or SFTP…, Creates the local or partner profile to use for AS2 transfers., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:amazonaws-transfer/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-transfer`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://apizie.tech/api/cloud/amazonaws-transfer
- OpenAPI: https://apizie.tech/api/cloud/amazonaws-transfer/openapi.json

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…

## Endpoints

### Used by administrators to choose which groups in the directory should have access to upload and download…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/create-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/create-agreement` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates the connector, which captures the parameters for an outbound connection for the AS2 or SFTP…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/create-connector` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates the local or partner profile to use for AS2 transfers.
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/create-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/create-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates a user and associates them with an existing file transfer protocol-enabled server. You can only…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/create-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Allows you to create a workflow with specified steps and step details the workflow invokes after file…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/create-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Allows you to delete the access specified in the ServerID and ExternalID parameters.
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/delete-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Delete the agreement that's specified in the provided AgreementId .
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/delete-agreement` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes the certificate that's specified in the CertificateId parameter.
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/delete-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes the connector that's specified in the provided ConnectorId .
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/delete-connector` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes the host key that's specified in the HostKeyId parameter.
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/delete-host-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes the profile that's specified in the ProfileId parameter.
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/delete-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes the file transfer protocol-enabled server that you specify. No response returns from this operation.
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/delete-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes a user's Secure Shell (SSH) public key.
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/delete-ssh-public-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes the user belonging to a file transfer protocol-enabled server you specify. No response returns from…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/delete-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes the specified workflow.
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/delete-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/describe-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes the agreement that's identified by the AgreementId .
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/describe-agreement` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes the certificate that's identified by the CertificateId .
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/describe-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes the connector that's identified by the ConnectorId.
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/describe-connector` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### You can use DescribeExecution to check the details of the execution of the specified workflow. This API call…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/describe-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Returns the details of the host key that's specified by the HostKeyId and ServerId .
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/describe-host-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Returns the details of the profile that's specified by the ProfileId .
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/describe-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes the security policy that is attached to your file transfer protocol-enabled server. The response…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/describe-security-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter. The…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/describe-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/describe-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes the specified workflow.
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/describe-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/import-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Adds a host key to the server that's specified by the ServerId parameter.
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/import-host-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a UserName value assigned to…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/import-ssh-public-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Lists the details for all the accesses you have on your server.
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/list-accesses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | integer | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns a list of the agreements for the server that's identified by the ServerId that you supply. If you…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/list-agreements` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | integer | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns a list of the current certificates that have been imported into Transfer Family. If you want to…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/list-certificates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | integer | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Lists the connectors for the specified Region.
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/list-connectors` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | integer | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Lists all in-progress executions for the specified workflow. If the specified workflow ID cannot be found,…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/list-executions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | integer | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns a list of host keys for the server that's specified by the ServerId parameter.
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/list-host-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/list-profiles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | integer | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Lists the security policies that are attached to your file transfer protocol-enabled servers.
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/list-security-policies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | integer | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/list-servers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | integer | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | integer | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/list-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | integer | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Lists all workflows associated with your Amazon Web Services account for your current region.
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/list-workflows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | integer | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Sends a callback for asynchronous custom steps. The ExecutionId , WorkflowId , and Token are passed to the…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/send-workflow-step-state` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server. For an AS2…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/start-file-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE . It has no impact on a…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/start-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE . An OFFLINE server…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/stop-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Tests whether your SFTP connector is set up successfully. We highly recommend that you call this operation…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/test-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/test-identity-provider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/update-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Updates some of the parameters for an existing agreement. Provide the AgreementId and the ServerId for the…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/update-agreement` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Updates the active and inactive dates for a certificate.
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/update-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Updates some of the parameters for an existing connector. Provide the ConnectorId for the connector that you…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/update-connector` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Updates the description for the host key that's specified by the ServerId and HostKeyId parameters.
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/update-host-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Updates some of the parameters for an existing profile. Provide the ProfileId for the profile that you want…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/update-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Updates the file transfer protocol-enabled server's properties after that server has been created. The…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/update-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Assigns new properties to a user. Parameters you pass modify any or all of the following: the home…
`POST https://apizie.tech/v1/cloud:amazonaws-transfer/update-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

## Example
```
curl "https://apizie.tech/v1/cloud:amazonaws-transfer/create-access" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the AWS Transfer Family API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:amazonaws-transfer/create-access with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the AWS Transfer Family API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. AWS Transfer Family itself also needs your own key from amazonaws.com.

### Can AI agents use the AWS Transfer Family API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-transfer.

### What is the status of the AWS Transfer Family API?
Needs your own provider key (bring your own key)