AWS Migration Hub Orchestrator
This API reference provides descriptions, syntax, and other details about each of the actions and data types for AWS Migration Hub Orchestrator. The topic for…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This API reference provides descriptions, syntax, and other details about each of the
actions and data types for AWS Migration Hub Orchestrator. The topic for each action shows the API
request parameters and responses. Alternatively, you can use one of the AWS SDKs to
access an API that is tailored to the programming language or platform that you're
using.
Endpoints 31
Migration workflow template
- POSTCreate template
/templateCreates a migration workflow template. - POSTUpdate template
/template/:idUpdates a migration workflow template. - DELETEDelete template
/template/:idDeletes a migration workflow template. - GETGet template
/migrationworkflowtemplate/:idGet the template you want to use for creating a migration workflow. - GETList templates
/migrationworkflowtemplates?maxResults=0&nextToken=string&name=stringList the templates available in Migration Hub Orchestrator to create a migration workflow.
Migration workflow
- POSTCreate workflow
/migrationworkflow/Create a workflow to orchestrate your migrations. - GETGet workflow
/migrationworkflow/:idGet migration workflow. - POSTUpdate workflow
/migrationworkflow/:idUpdate a migration workflow. - DELETEDelete workflow
/migrationworkflow/:idDelete a migration workflow. You must pause a running workflow in Migration Hub Orchestrator console to delete it. - GETList workflows
/migrationworkflows?maxResults=0&nextToken=string&templateId=string&adsApplicationConfigurationName=string&status=string&name=stringList the migration workflows. - POSTStart workflow
/migrationworkflow/:id/startStart a migration workflow. - POSTStop workflow
/migrationworkflow/:id/stopStop an ongoing migration workflow.
Workflow step
- POSTCreate workflow step
/workflowstepCreate a step in the migration workflow. - GETGet workflow step
/workflowstep/:id?workflowId=string&stepGroupId=stringGet a step in the migration workflow. - POSTUpdate workflow step
/workflowstep/:idUpdate a step in a migration workflow. - DELETEDelete workflow step
/workflowstep/:id?stepGroupId=string&workflowId=stringDelete a step in a migration workflow. Pause the workflow to delete a running step. - GETList workflow steps
/workflow/:workflowId/workflowstepgroups/:stepGroupId/workflowsteps?nextToken=string&maxResults=0List the steps in a workflow. - POSTRetry workflow step
/retryworkflowstep/:id?workflowId=string&stepGroupId=stringRetry a failed step in a migration workflow.
Workflow step group
- GETList workflow step groups
/workflowstepgroups?nextToken=string&maxResults=0&workflowId=stringList the step groups in a migration workflow. - POSTCreate workflow step group
/workflowstepgroupsCreate a step group in a migration workflow. - GETGet workflow step group
/workflowstepgroup/:id?workflowId=stringGet the step group of a migration workflow. - POSTUpdate workflow step group
/workflowstepgroup/:id?workflowId=stringUpdate the step group in a migration workflow. - DELETEDelete workflow step group
/workflowstepgroup/:id?workflowId=stringDelete a step group in a migration workflow.
Template step
- GETGet template step
/templatestep/:id?templateId=string&stepGroupId=stringGet a specific step in a template. - GETList template steps
/templatesteps?maxResults=0&nextToken=string&templateId=string&stepGroupId=stringList the steps in a template.
Template step group
- GETGet template step group
/templates/:templateId/stepgroups/:idGet a step group in a template.
Plugin
- GETList plugins
/plugins?maxResults=0&nextToken=stringList AWS Migration Hub Orchestrator plugins.
Template step groups
- GETList template step groups
/templatestepgroups/:templateId?maxResults=0&nextToken=stringList the step groups in a template.
- GETList tags for resource
/tags/:resourceArnList the tags added to a resource. - POSTTag resource
/tags/:resourceArnTag a resource by specifying its Amazon Resource Name (ARN). - DELETEUntag resource
/tags/:resourceArn?tagKeys=Deletes the tags for a resource.
API details
- Base URL
https://migrationhub-orchestrator.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 31 operations on 21 pathsGET 14POST 12DELETE 5
- Main resources
- Migration workflow 7Workflow step 6Migration workflow template 5Workflow step group 5Template step 2Plugin 1Template step group 1Template step groups 1
- Description format
- AWS Smithy model, API version
2021-08-28 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Migration Hub Orchestrator in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Migration Hub Orchestrator collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create template” (POST /template), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Migration Hub Orchestrator?
This API reference provides descriptions, syntax, and other details about each of the actions and data types for AWS Migration Hub Orchestrator. The topic for… It is listed under Developer tools and has 31 endpoints.
Who publishes the AWS Migration Hub Orchestrator?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Migration Hub Orchestrator?
Requests go to https://migrationhub-orchestrator.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Migration Hub Orchestrator?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Migration Hub Orchestrator have?
31 operations on 21 paths (14 GET, 12 POST, 5 DELETE). The largest groups are Migration workflow, Workflow step, Migration workflow template, Workflow step group.
Is forking the AWS Migration Hub Orchestrator free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.