Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListTemplates

List the templates available in Migration Hub Orchestrator to create a migration workflow.

Request Syntax


GET /migrationworkflowtemplates?maxResults=maxResults&name=name&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results that can be returned.

Valid Range: Minimum value of 0. Maximum value of 100.

name

The name of the template.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*

nextToken

The pagination token.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*\S.*

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "templateSummary": [ 
      { 
         "arn": "string",
         "description": "string",
         "id": "string",
         "name": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

The pagination token.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*\S.*

templateSummary

The summary of the template.

Type: Array of TemplateSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An internal error has occurred.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429