GetTemplateStep - Migration Hub Orchestrator
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetTemplateStep

Get a specific step in a template.

Request Syntax

GET /templatestep/id?stepGroupId=stepGroupId&templateId=templateId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

id

The ID of the step.

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

Pattern: [a-zA-Z0-9-]+

Required: Yes

stepGroupId

The ID of the step group.

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

Pattern: [a-zA-Z0-9-]+

Required: Yes

templateId

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": "string",
   "description": "string",
   "id": "string",
   "name": "string",
   "next": [ "string" ],
   "outputs": [ 
      { 
         "dataType": "string",
         "name": "string",
         "required": boolean
      }
   ],
   "previous": [ "string" ],
   "stepActionType": "string",
   "stepAutomationConfiguration": { 
      "command": { 
         "linux": "string",
         "windows": "string"
      },
      "runEnvironment": "string",
      "scriptLocationS3Bucket": "string",
      "scriptLocationS3Key": { 
         "linux": "string",
         "windows": "string"
      },
      "targetType": "string"
   },
   "stepGroupId": "string",
   "templateId": "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 step was created.

Type: String

description

The description of the step.

Type: String

id

The ID of the step.

Type: String

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

Pattern: [a-zA-Z0-9-]+

name

The name of the step.

Type: String

next

The next step.

Type: Array of strings

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

outputs

The outputs of the step.

Type: Array of StepOutput objects

previous

The previous step.

Type: Array of strings

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

stepActionType

The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.

Type: String

Valid Values: MANUAL | AUTOMATED

stepAutomationConfiguration

The custom script to run tests on source or target environments.

Type: StepAutomationConfiguration object

stepGroupId

The ID of the step group.

Type: String

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

Pattern: [a-zA-Z0-9-]+

templateId

The ID of the template.

Type: String

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

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

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

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: