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

GetTemplate

Get the template you want to use for creating a migration workflow.

Request Syntax


GET /migrationworkflowtemplate/id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

id

The ID of the template.

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "creationTime": number,
   "description": "string",
   "id": "string",
   "inputs": [ 
      { 
         "dataType": "string",
         "inputName": "string",
         "required": boolean
      }
   ],
   "name": "string",
   "owner": "string",
   "status": "string",
   "statusMessage": "string",
   "tags": { 
      "string" : "string" 
   },
   "templateArn": "string",
   "templateClass": "string",
   "tools": [ 
      { 
         "name": "string",
         "url": "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.

creationTime

The time at which the template was last created.

Type: Timestamp

description

The time at which the template was last created.

Type: String

id

The ID of the template.

Type: String

inputs

The inputs provided for the creation of the migration workflow.

Type: Array of TemplateInput objects

name

The name of the template.

Type: String

owner

The owner of the migration workflow template.

Type: String

status

The status of the template.

Type: String

Valid Values: CREATED | READY | PENDING_CREATION | CREATING | CREATION_FAILED

statusMessage

The status message of retrieving migration workflow templates.

Type: String

tags

The tags added to the migration workflow template.

Type: String to string map

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

Key Pattern: [a-zA-Z0-9-_ ()]+

Value Length Constraints: Minimum length of 0. Maximum length of 100.

templateArn

>The Amazon Resource Name (ARN) of the migration workflow template. The format for an Migration Hub Orchestrator template ARN is arn:aws:migrationhub-orchestrator:region:account:template/template-abcd1234. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

Type: String

templateClass

The class of the migration workflow template. The available template classes are:

A2C
MGN
SAP_MULTI
SQL_EC2
SQL_RDS
VMIE

Type: String

tools

List of AWS services utilized in a migration workflow.

Type: Array of Tool 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

ResourceNotFoundException

The resource is not available.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429