# AWS Migration Hub Orchestrator API

> AWS Migration Hub Orchestrator API on Apizie: 28 endpoints (Create a workflow to orchestrate your migrations., Create a step in the migration workflow., Create a step group in a migration workflow., Get migration workflow., …) 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://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-migrationhuborchestrator`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://zieapi.vercel.app/api/cloud/amazonaws-migrationhuborchestrator
- OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-migrationhuborchestrator/openapi.json

This API reference provides descriptions, syntax, and other details about each of the actions and data types for AWS Migration Hub Orchestrator. he topic for each action shows the API request parameters and the…

## Endpoints

### Create a workflow to orchestrate your migrations.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/create-workflow` (byok)

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

### Create a step in the migration workflow.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/create-workflow-step` (byok)

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

### Create a step group in a migration workflow.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/create-workflow-step-group` (byok)

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

### Get migration workflow.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/get-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| id | string | yes | The ID of the migration workflow. |

### Update a migration workflow.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/update-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| id | string | yes | The ID of the migration workflow. |
| body | object | yes | JSON request body |

### Delete a migration workflow. You must pause a running workflow in Migration Hub Orchestrator console to…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/delete-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| id | string | yes | The ID of the migration workflow you want to delete. |

### Delete a step in a migration workflow. Pause the workflow to delete a running step.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/delete-workflow-step` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| id | string | yes | The ID of the step you want to delete. |
| stepGroupId | string | yes | The ID of the step group that contains the step you want to delete. |
| workflowId | string | yes | The ID of the migration workflow. |

### Get the step group of a migration workflow.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/get-workflow-step-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| id | string | yes | The ID of the step group. |
| workflowId | string | yes | The ID of the migration workflow. |

### Update the step group in a migration workflow.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/update-workflow-step-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workflowId | string | yes | The ID of the migration workflow. |
| id | string | yes | The ID of the step group. |
| body | object | yes | JSON request body |

### Delete a step group in a migration workflow.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/delete-workflow-step-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workflowId | string | yes | The ID of the migration workflow. |
| id | string | yes | The ID of the step group you want to delete. |

### Get the template you want to use for creating a migration workflow.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/get-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| id | string | yes | The ID of the template. |

### Get a specific step in a template.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/get-template-step` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| id | string | yes | The ID of the step. |
| templateId | string | yes | The ID of the template. |
| stepGroupId | string | yes | The ID of the step group. |

### Get a step group in a template.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/get-template-step-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| templateId | string | yes | The ID of the template. |
| id | string | yes | The ID of the step group. |

### Get a step in the migration workflow.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/get-workflow-step` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workflowId | string | yes | The ID of the migration workflow. |
| stepGroupId | string | yes | desThe ID of the step group. |
| id | string | yes | The ID of the step. |

### List AWS Migration Hub Orchestrator plugins.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/list-plugins` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | integer | no | The maximum number of plugins that can be returned. |
| nextToken | string | no | The pagination token. |

### List the tags added to a resource.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The Amazon Resource Name (ARN) of the resource. |

### Tag a resource by specifying its Amazon Resource Name (ARN).
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The Amazon Resource Name (ARN) of the resource to which you want to add tags. |
| body | object | yes | JSON request body |

### List the step groups in a template.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/list-template-step-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | integer | no | The maximum number of results that can be returned. |
| nextToken | string | no | The pagination token. |
| templateId | string | yes | The ID of the template. |

### List the steps in a template.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/list-template-steps` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | integer | no | The maximum number of results that can be returned. |
| nextToken | string | no | The pagination token. |
| templateId | string | yes | The ID of the template. |
| stepGroupId | string | yes | The ID of the step group. |

### List the templates available in Migration Hub Orchestrator to create a migration workflow.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/list-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | integer | no | The maximum number of results that can be returned. |
| nextToken | string | no | The pagination token. |
| name | string | no | The name of the template. |

### List the step groups in a migration workflow.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/list-workflow-step-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | The pagination token. |
| maxResults | integer | no | The maximum number of results that can be returned. |
| workflowId | string | yes | The ID of the migration workflow. |

### List the steps in a workflow.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/list-workflow-steps` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | The pagination token. |
| maxResults | integer | no | The maximum number of results that can be returned. |
| workflowId | string | yes | The ID of the migration workflow. |
| stepGroupId | string | yes | The ID of the step group. |

### List the migration workflows.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/list-workflows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | integer | no | The maximum number of results that can be returned. |
| nextToken | string | no | The pagination token. |
| templateId | string | no | The ID of the template. |
| adsApplicationConfigurationName | string | no | The name of the application configured in Application Discovery Service. |
| status | string | no | The status of the migration workflow. |
| name | string | no | The name of the migration workflow. |

### Retry a failed step in a migration workflow.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/retry-workflow-step` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| workflowId | string | yes | The ID of the migration workflow. |
| stepGroupId | string | yes | The ID of the step group. |
| id | string | yes | The ID of the step. |

### Start a migration workflow.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/start-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| id | string | yes | The ID of the migration workflow. |

### Stop an ongoing migration workflow.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/stop-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| id | string | yes | The ID of the migration workflow. |

### Deletes the tags for a resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The Amazon Resource Name (ARN) of the resource from which you want to remove tags. |
| tagKeys | array | yes | One or more tag keys. Specify only the tag keys, not the tag values. |

### Update a step in a migration workflow.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/update-workflow-step` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| id | string | yes | The ID of the step. |
| body | object | yes | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/create-workflow" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the AWS Migration Hub Orchestrator API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:amazonaws-migrationhuborchestrator/create-workflow with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the AWS Migration Hub Orchestrator API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-migrationhuborchestrator.

### What is the status of the AWS Migration Hub Orchestrator API?
Needs your own provider key (bring your own key)