Class: AWS.MigrationHubOrchestrator

var params = {
  inputParameters: { /* required */
    '<StepInputParametersKey>': {
      integerValue: 'NUMBER_VALUE',
      listOfStringsValue: [
        'STRING_VALUE',
        /* more items */
      ],
      mapOfStringValue: {
        '<StringMapKey>': 'STRING_VALUE',
        /* '<StringMapKey>': ... */
      },
      stringValue: 'STRING_VALUE'
    },
    /* '<StepInputParametersKey>': ... */
  },
  name: 'STRING_VALUE', /* required */
  templateId: 'STRING_VALUE', /* required */
  applicationConfigurationId: 'STRING_VALUE',
  description: 'STRING_VALUE',
  stepTargets: [
    'STRING_VALUE',
    /* more items */
  ],
  tags: {
    '<StringMapKey>': 'STRING_VALUE',
    /* '<StringMapKey>': ... */
  }
};
migrationhuborchestrator.createWorkflow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The name of the migration workflow.

  • description — (String)

    The description of the migration workflow.

  • templateId — (String)

    The ID of the template.

  • applicationConfigurationId — (String)

    The configuration ID of the application configured in Application Discovery Service.

  • inputParameters — (map<map>)

    The input parameters required to create a migration workflow.

    • integerValue — (Integer)

      The value of the integer.

    • stringValue — (String)

      String value.

    • listOfStringsValue — (Array<String>)

      List of string values.

    • mapOfStringValue — (map<String>)

      Map of string values.

  • stepTargets — (Array<String>)

    The servers on which a step will be run.

  • tags — (map<String>)

    The tags to add on a migration workflow.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      The ID of the migration workflow.

    • arn — (String)

      The Amazon Resource Name (ARN) of the migration workflow.

    • name — (String)

      The name of the migration workflow.

    • description — (String)

      The description of the migration workflow.

    • templateId — (String)

      The ID of the template.

    • adsApplicationConfigurationId — (String)

      The configuration ID of the application configured in Application Discovery Service.

    • workflowInputs — (map<map>)

      The inputs for creating a migration workflow.

      • integerValue — (Integer)

        The value of the integer.

      • stringValue — (String)

        String value.

      • listOfStringsValue — (Array<String>)

        List of string values.

      • mapOfStringValue — (map<String>)

        Map of string values.

    • stepTargets — (Array<String>)

      The servers on which a step will be run.

    • status — (String)

      The status of the migration workflow.

      Possible values include:
      • "CREATING"
      • "NOT_STARTED"
      • "CREATION_FAILED"
      • "STARTING"
      • "IN_PROGRESS"
      • "WORKFLOW_FAILED"
      • "PAUSED"
      • "PAUSING"
      • "PAUSING_FAILED"
      • "USER_ATTENTION_REQUIRED"
      • "DELETING"
      • "DELETION_FAILED"
      • "DELETED"
      • "COMPLETED"
    • creationTime — (Date)

      The time at which the migration workflow was created.

    • tags — (map<String>)

      The tags to add on a migration workflow.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  stepActionType: MANUAL | AUTOMATED, /* required */
  stepGroupId: 'STRING_VALUE', /* required */
  workflowId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  next: [
    'STRING_VALUE',
    /* more items */
  ],
  outputs: [
    {
      dataType: STRING | INTEGER | STRINGLIST | STRINGMAP,
      name: 'STRING_VALUE',
      required: true || false,
      value: {
        integerValue: 'NUMBER_VALUE',
        listOfStringValue: [
          'STRING_VALUE',
          /* more items */
        ],
        stringValue: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  previous: [
    'STRING_VALUE',
    /* more items */
  ],
  stepTarget: [
    'STRING_VALUE',
    /* more items */
  ],
  workflowStepAutomationConfiguration: {
    command: {
      linux: 'STRING_VALUE',
      windows: 'STRING_VALUE'
    },
    runEnvironment: AWS | ONPREMISE,
    scriptLocationS3Bucket: 'STRING_VALUE',
    scriptLocationS3Key: {
      linux: 'STRING_VALUE',
      windows: 'STRING_VALUE'
    },
    targetType: SINGLE | ALL | NONE
  }
};
migrationhuborchestrator.createWorkflowStep(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The name of the step.

  • stepGroupId — (String)

    The ID of the step group.

  • workflowId — (String)

    The ID of the migration workflow.

  • stepActionType — (String)

    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.

    Possible values include:
    • "MANUAL"
    • "AUTOMATED"
  • description — (String)

    The description of the step.

  • workflowStepAutomationConfiguration — (map)

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

    • scriptLocationS3Bucket — (String)

      The Amazon S3 bucket where the script is located.

    • scriptLocationS3Key — (map)

      The Amazon S3 key for the script location.

      • linux — (String)

        The script location for Linux.

      • windows — (String)

        The script location for Windows.

    • command — (map)

      The command required to run the script.

      • linux — (String)

        Command for Linux.

      • windows — (String)

        Command for Windows.

    • runEnvironment — (String)

      The source or target environment.

      Possible values include:
      • "AWS"
      • "ONPREMISE"
    • targetType — (String)

      The servers on which to run the script.

      Possible values include:
      • "SINGLE"
      • "ALL"
      • "NONE"
  • stepTarget — (Array<String>)

    The servers on which a step will be run.

  • outputs — (Array<map>)

    The key value pairs added for the expected output.

    • name — (String)

      The name of the step.

    • dataType — (String)

      The data type of the output.

      Possible values include:
      • "STRING"
      • "INTEGER"
      • "STRINGLIST"
      • "STRINGMAP"
    • required — (Boolean)

      Determine if an output is required from a step.

    • value — (map)

      The value of the output.

      • integerValue — (Integer)

        The integer value.

      • stringValue — (String)

        The string value.

      • listOfStringValue — (Array<String>)

        The list of string value.

  • previous — (Array<String>)

    The previous step.

  • next — (Array<String>)

    The next step.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      The ID of the step.

    • stepGroupId — (String)

      The ID of the step group.

    • workflowId — (String)

      The ID of the migration workflow.

    • name — (String)

      The name of the step.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  workflowId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  next: [
    'STRING_VALUE',
    /* more items */
  ],
  previous: [
    'STRING_VALUE',
    /* more items */
  ]
};
migrationhuborchestrator.createWorkflowStepGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • workflowId — (String)

    The ID of the migration workflow that will contain the step group.

  • name — (String)

    The name of the step group.

  • description — (String)

    The description of the step group.

  • next — (Array<String>)

    The next step group.

  • previous — (Array<String>)

    The previous step group.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • workflowId — (String)

      The ID of the migration workflow that contains the step group.

    • name — (String)

      The name of the step group.

    • id — (String)

      The ID of the step group.

    • description — (String)

      The description of the step group.

    • tools — (Array<map>)

      List of AWS services utilized in a migration workflow.

      • name — (String)

        The name of an AWS service.

      • url — (String)

        The URL of an AWS service.

    • next — (Array<String>)

      The next step group.

    • previous — (Array<String>)

      The previous step group.

    • creationTime — (Date)

      The time at which the step group is created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
migrationhuborchestrator.deleteTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The ID of the request to delete a migration workflow template.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
migrationhuborchestrator.deleteWorkflow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The ID of the migration workflow you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      The ID of the migration workflow.

    • arn — (String)

      The Amazon Resource Name (ARN) of the migration workflow.

    • status — (String)

      The status of the migration workflow.

      Possible values include:
      • "CREATING"
      • "NOT_STARTED"
      • "CREATION_FAILED"
      • "STARTING"
      • "IN_PROGRESS"
      • "WORKFLOW_FAILED"
      • "PAUSED"
      • "PAUSING"
      • "PAUSING_FAILED"
      • "USER_ATTENTION_REQUIRED"
      • "DELETING"
      • "DELETION_FAILED"
      • "DELETED"
      • "COMPLETED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  stepGroupId: 'STRING_VALUE', /* required */
  workflowId: 'STRING_VALUE' /* required */
};
migrationhuborchestrator.deleteWorkflowStep(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The ID of the step you want to delete.

  • stepGroupId — (String)

    The ID of the step group that contains the step you want to delete.

  • workflowId — (String)

    The ID of the migration workflow.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  workflowId: 'STRING_VALUE' /* required */
};
migrationhuborchestrator.deleteWorkflowStepGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • workflowId — (String)

    The ID of the migration workflow.

  • id — (String)

    The ID of the step group you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
migrationhuborchestrator.getTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The ID of the template.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      The ID of the template.

    • templateArn — (String)

      >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.

    • name — (String)

      The name of the template.

    • description — (String)

      The time at which the template was last created.

    • inputs — (Array<map>)

      The inputs provided for the creation of the migration workflow.

      • inputName — (String)

        The name of the template.

      • dataType — (String)

        The data type of the template input.

        Possible values include:
        • "STRING"
        • "INTEGER"
        • "STRINGLIST"
        • "STRINGMAP"
      • required — (Boolean)

        Determine if an input is required from the template.

    • tools — (Array<map>)

      List of AWS services utilized in a migration workflow.

      • name — (String)

        The name of an AWS service.

      • url — (String)

        The URL of an AWS service.

    • creationTime — (Date)

      The time at which the template was last created.

    • owner — (String)

      The owner of the migration workflow template.

    • status — (String)

      The status of the template.

      Possible values include:
      • "CREATED"
      • "READY"
      • "PENDING_CREATION"
      • "CREATING"
      • "CREATION_FAILED"
    • statusMessage — (String)

      The status message of retrieving migration workflow templates.

    • templateClass — (String)

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

      • A2C

      • MGN

      • SAP_MULTI

      • SQL_EC2

      • SQL_RDS

      • VMIE

    • tags — (map<String>)

      The tags added to the migration workflow template.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  stepGroupId: 'STRING_VALUE', /* required */
  templateId: 'STRING_VALUE' /* required */
};
migrationhuborchestrator.getTemplateStep(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The ID of the step.

  • templateId — (String)

    The ID of the template.

  • stepGroupId — (String)

    The ID of the step group.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      The ID of the step.

    • stepGroupId — (String)

      The ID of the step group.

    • templateId — (String)

      The ID of the template.

    • name — (String)

      The name of the step.

    • description — (String)

      The description of the step.

    • stepActionType — (String)

      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.

      Possible values include:
      • "MANUAL"
      • "AUTOMATED"
    • creationTime — (String)

      The time at which the step was created.

    • previous — (Array<String>)

      The previous step.

    • next — (Array<String>)

      The next step.

    • outputs — (Array<map>)

      The outputs of the step.

      • name — (String)

        The name of the step.

      • dataType — (String)

        The data type of the step output.

        Possible values include:
        • "STRING"
        • "INTEGER"
        • "STRINGLIST"
        • "STRINGMAP"
      • required — (Boolean)

        Determine if an output is required from a step.

    • stepAutomationConfiguration — (map)

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

      • scriptLocationS3Bucket — (String)

        The Amazon S3 bucket where the script is located.

      • scriptLocationS3Key — (map)

        The Amazon S3 key for the script location.

        • linux — (String)

          The script location for Linux.

        • windows — (String)

          The script location for Windows.

      • command — (map)

        The command to run the script.

        • linux — (String)

          Command for Linux.

        • windows — (String)

          Command for Windows.

      • runEnvironment — (String)

        The source or target environment.

        Possible values include:
        • "AWS"
        • "ONPREMISE"
      • targetType — (String)

        The servers on which to run the script.

        Possible values include:
        • "SINGLE"
        • "ALL"
        • "NONE"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  templateId: 'STRING_VALUE' /* required */
};
migrationhuborchestrator.getTemplateStepGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • templateId — (String)

    The ID of the template.

  • id — (String)

    The ID of the step group.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • templateId — (String)

      The ID of the template.

    • id — (String)

      The ID of the step group.

    • name — (String)

      The name of the step group.

    • description — (String)

      The description of the step group.

    • status — (String)

      The status of the step group.

      Possible values include:
      • "AWAITING_DEPENDENCIES"
      • "READY"
      • "IN_PROGRESS"
      • "COMPLETED"
      • "FAILED"
      • "PAUSED"
      • "PAUSING"
      • "USER_ATTENTION_REQUIRED"
    • creationTime — (Date)

      The time at which the step group was created.

    • lastModifiedTime — (Date)

      The time at which the step group was last modified.

    • tools — (Array<map>)

      List of AWS services utilized in a migration workflow.

      • name — (String)

        The name of an AWS service.

      • url — (String)

        The URL of an AWS service.

    • previous — (Array<String>)

      The previous step group.

    • next — (Array<String>)

      The next step group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
migrationhuborchestrator.getWorkflow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The ID of the migration workflow.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      The ID of the migration workflow.

    • arn — (String)

      The Amazon Resource Name (ARN) of the migration workflow.

    • name — (String)

      The name of the migration workflow.

    • description — (String)

      The description of the migration workflow.

    • templateId — (String)

      The ID of the template.

    • adsApplicationConfigurationId — (String)

      The configuration ID of the application configured in Application Discovery Service.

    • adsApplicationName — (String)

      The name of the application configured in Application Discovery Service.

    • status — (String)

      The status of the migration workflow.

      Possible values include:
      • "CREATING"
      • "NOT_STARTED"
      • "CREATION_FAILED"
      • "STARTING"
      • "IN_PROGRESS"
      • "WORKFLOW_FAILED"
      • "PAUSED"
      • "PAUSING"
      • "PAUSING_FAILED"
      • "USER_ATTENTION_REQUIRED"
      • "DELETING"
      • "DELETION_FAILED"
      • "DELETED"
      • "COMPLETED"
    • statusMessage — (String)

      The status message of the migration workflow.

    • creationTime — (Date)

      The time at which the migration workflow was created.

    • lastStartTime — (Date)

      The time at which the migration workflow was last started.

    • lastStopTime — (Date)

      The time at which the migration workflow was last stopped.

    • lastModifiedTime — (Date)

      The time at which the migration workflow was last modified.

    • endTime — (Date)

      The time at which the migration workflow ended.

    • tools — (Array<map>)

      List of AWS services utilized in a migration workflow.

      • name — (String)

        The name of an AWS service.

      • url — (String)

        The URL of an AWS service.

    • totalSteps — (Integer)

      The total number of steps in the migration workflow.

    • completedSteps — (Integer)

      Get a list of completed steps in the migration workflow.

    • workflowInputs — (map<map>)

      The inputs required for creating the migration workflow.

      • integerValue — (Integer)

        The value of the integer.

      • stringValue — (String)

        String value.

      • listOfStringsValue — (Array<String>)

        List of string values.

      • mapOfStringValue — (map<String>)

        Map of string values.

    • tags — (map<String>)

      The tags added to the migration workflow.

    • workflowBucket — (String)

      The Amazon S3 bucket where the migration logs are stored.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  stepGroupId: 'STRING_VALUE', /* required */
  workflowId: 'STRING_VALUE' /* required */
};
migrationhuborchestrator.getWorkflowStep(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • workflowId — (String)

    The ID of the migration workflow.

  • stepGroupId — (String)

    The ID of the step group.

  • id — (String)

    The ID of the step.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • name — (String)

      The name of the step.

    • stepGroupId — (String)

      The ID of the step group.

    • workflowId — (String)

      The ID of the migration workflow.

    • stepId — (String)

      The ID of the step.

    • description — (String)

      The description of the step.

    • stepActionType — (String)

      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.

      Possible values include:
      • "MANUAL"
      • "AUTOMATED"
    • owner — (String)

      The owner of the step.

      Possible values include:
      • "AWS_MANAGED"
      • "CUSTOM"
    • workflowStepAutomationConfiguration — (map)

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

      • scriptLocationS3Bucket — (String)

        The Amazon S3 bucket where the script is located.

      • scriptLocationS3Key — (map)

        The Amazon S3 key for the script location.

        • linux — (String)

          The script location for Linux.

        • windows — (String)

          The script location for Windows.

      • command — (map)

        The command required to run the script.

        • linux — (String)

          Command for Linux.

        • windows — (String)

          Command for Windows.

      • runEnvironment — (String)

        The source or target environment.

        Possible values include:
        • "AWS"
        • "ONPREMISE"
      • targetType — (String)

        The servers on which to run the script.

        Possible values include:
        • "SINGLE"
        • "ALL"
        • "NONE"
    • stepTarget — (Array<String>)

      The servers on which a step will be run.

    • outputs — (Array<map>)

      The outputs of the step.

      • name — (String)

        The name of the step.

      • dataType — (String)

        The data type of the output.

        Possible values include:
        • "STRING"
        • "INTEGER"
        • "STRINGLIST"
        • "STRINGMAP"
      • required — (Boolean)

        Determine if an output is required from a step.

      • value — (map)

        The value of the output.

        • integerValue — (Integer)

          The integer value.

        • stringValue — (String)

          The string value.

        • listOfStringValue — (Array<String>)

          The list of string value.

    • previous — (Array<String>)

      The previous step.

    • next — (Array<String>)

      The next step.

    • status — (String)

      The status of the step.

      Possible values include:
      • "AWAITING_DEPENDENCIES"
      • "SKIPPED"
      • "READY"
      • "IN_PROGRESS"
      • "COMPLETED"
      • "FAILED"
      • "PAUSED"
      • "USER_ATTENTION_REQUIRED"
    • statusMessage — (String)

      The status message of the migration workflow.

    • scriptOutputLocation — (String)

      The output location of the script.

    • creationTime — (Date)

      The time at which the step was created.

    • lastStartTime — (Date)

      The time at which the workflow was last started.

    • endTime — (Date)

      The time at which the step ended.

    • noOfSrvCompleted — (Integer)

      The number of servers that have been migrated.

    • noOfSrvFailed — (Integer)

      The number of servers that have failed to migrate.

    • totalNoOfSrv — (Integer)

      The total number of servers that have been migrated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  workflowId: 'STRING_VALUE' /* required */
};
migrationhuborchestrator.getWorkflowStepGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The ID of the step group.

  • workflowId — (String)

    The ID of the migration workflow.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      The ID of the step group.

    • workflowId — (String)

      The ID of the migration workflow.

    • name — (String)

      The name of the step group.

    • description — (String)

      The description of the step group.

    • status — (String)

      The status of the step group.

      Possible values include:
      • "AWAITING_DEPENDENCIES"
      • "READY"
      • "IN_PROGRESS"
      • "COMPLETED"
      • "FAILED"
      • "PAUSED"
      • "PAUSING"
      • "USER_ATTENTION_REQUIRED"
    • owner — (String)

      The owner of the step group.

      Possible values include:
      • "AWS_MANAGED"
      • "CUSTOM"
    • creationTime — (Date)

      The time at which the step group was created.

    • lastModifiedTime — (Date)

      The time at which the step group was last modified.

    • endTime — (Date)

      The time at which the step group ended.

    • tools — (Array<map>)

      List of AWS services utilized in a migration workflow.

      • name — (String)

        The name of an AWS service.

      • url — (String)

        The URL of an AWS service.

    • previous — (Array<String>)

      The previous step group.

    • next — (Array<String>)

      The next step group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
migrationhuborchestrator.listPlugins(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of plugins that can be returned.

  • nextToken — (String)

    The pagination token.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The pagination token.

    • plugins — (Array<map>)

      Migration Hub Orchestrator plugins.

      • pluginId — (String)

        The ID of the plugin.

      • hostname — (String)

        The name of the host.

      • status — (String)

        The status of the plugin.

        Possible values include:
        • "HEALTHY"
        • "UNHEALTHY"
      • ipAddress — (String)

        The IP address at which the plugin is located.

      • version — (String)

        The version of the plugin.

      • registeredTime — (String)

        The time at which the plugin was registered.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
migrationhuborchestrator.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (map<String>)

      The tags added to a resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
migrationhuborchestrator.listTemplates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of results that can be returned.

  • nextToken — (String)

    The pagination token.

  • name — (String)

    The name of the template.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The pagination token.

    • templateSummary — (Array<map>)

      The summary of the template.

      • id — (String)

        The ID of the template.

      • name — (String)

        The name of the template.

      • arn — (String)

        The Amazon Resource Name (ARN) of the template.

      • description — (String)

        The description of the template.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  templateId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
migrationhuborchestrator.listTemplateStepGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of results that can be returned.

  • nextToken — (String)

    The pagination token.

  • templateId — (String)

    The ID of the template.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The pagination token.

    • templateStepGroupSummary — (Array<map>)

      The summary of the step group in the template.

      • id — (String)

        The ID of the step group.

      • name — (String)

        The name of the step group.

      • previous — (Array<String>)

        The previous step group.

      • next — (Array<String>)

        The next step group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  stepGroupId: 'STRING_VALUE', /* required */
  templateId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
migrationhuborchestrator.listTemplateSteps(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of results that can be returned.

  • nextToken — (String)

    The pagination token.

  • templateId — (String)

    The ID of the template.

  • stepGroupId — (String)

    The ID of the step group.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The pagination token.

    • templateStepSummaryList — (Array<map>)

      The list of summaries of steps in a template.

      • id — (String)

        The ID of the step.

      • stepGroupId — (String)

        The ID of the step group.

      • templateId — (String)

        The ID of the template.

      • name — (String)

        The name of the step.

      • stepActionType — (String)

        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.

        Possible values include:
        • "MANUAL"
        • "AUTOMATED"
      • targetType — (String)

        The servers on which to run the script.

        Possible values include:
        • "SINGLE"
        • "ALL"
        • "NONE"
      • owner — (String)

        The owner of the step.

        Possible values include:
        • "AWS_MANAGED"
        • "CUSTOM"
      • previous — (Array<String>)

        The previous step.

      • next — (Array<String>)

        The next step.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  adsApplicationConfigurationName: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  status: CREATING | NOT_STARTED | CREATION_FAILED | STARTING | IN_PROGRESS | WORKFLOW_FAILED | PAUSED | PAUSING | PAUSING_FAILED | USER_ATTENTION_REQUIRED | DELETING | DELETION_FAILED | DELETED | COMPLETED,
  templateId: 'STRING_VALUE'
};
migrationhuborchestrator.listWorkflows(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of results that can be returned.

  • nextToken — (String)

    The pagination token.

  • templateId — (String)

    The ID of the template.

  • adsApplicationConfigurationName — (String)

    The name of the application configured in Application Discovery Service.

  • status — (String)

    The status of the migration workflow.

    Possible values include:
    • "CREATING"
    • "NOT_STARTED"
    • "CREATION_FAILED"
    • "STARTING"
    • "IN_PROGRESS"
    • "WORKFLOW_FAILED"
    • "PAUSED"
    • "PAUSING"
    • "PAUSING_FAILED"
    • "USER_ATTENTION_REQUIRED"
    • "DELETING"
    • "DELETION_FAILED"
    • "DELETED"
    • "COMPLETED"
  • name — (String)

    The name of the migration workflow.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The pagination token.

    • migrationWorkflowSummary — (Array<map>)

      The summary of the migration workflow.

      • id — (String)

        The ID of the migration workflow.

      • name — (String)

        The name of the migration workflow.

      • templateId — (String)

        The ID of the template.

      • adsApplicationConfigurationName — (String)

        The name of the application configured in Application Discovery Service.

      • status — (String)

        The status of the migration workflow.

        Possible values include:
        • "CREATING"
        • "NOT_STARTED"
        • "CREATION_FAILED"
        • "STARTING"
        • "IN_PROGRESS"
        • "WORKFLOW_FAILED"
        • "PAUSED"
        • "PAUSING"
        • "PAUSING_FAILED"
        • "USER_ATTENTION_REQUIRED"
        • "DELETING"
        • "DELETION_FAILED"
        • "DELETED"
        • "COMPLETED"
      • creationTime — (Date)

        The time at which the migration workflow was created.

      • endTime — (Date)

        The time at which the migration workflow ended.

      • statusMessage — (String)

        The status message of the migration workflow.

      • completedSteps — (Integer)

        The steps completed in the migration workflow.

      • totalSteps — (Integer)

        All the steps in a migration workflow.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  workflowId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
migrationhuborchestrator.listWorkflowStepGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    The pagination token.

  • maxResults — (Integer)

    The maximum number of results that can be returned.

  • workflowId — (String)

    The ID of the migration workflow.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The pagination token.

    • workflowStepGroupsSummary — (Array<map>)

      The summary of step groups in a migration workflow.

      • id — (String)

        The ID of the step group.

      • name — (String)

        The name of the step group.

      • owner — (String)

        The owner of the step group.

        Possible values include:
        • "AWS_MANAGED"
        • "CUSTOM"
      • status — (String)

        The status of the step group.

        Possible values include:
        • "AWAITING_DEPENDENCIES"
        • "READY"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "PAUSED"
        • "PAUSING"
        • "USER_ATTENTION_REQUIRED"
      • previous — (Array<String>)

        The previous step group.

      • next — (Array<String>)

        The next step group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  stepGroupId: 'STRING_VALUE', /* required */
  workflowId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
migrationhuborchestrator.listWorkflowSteps(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    The pagination token.

  • maxResults — (Integer)

    The maximum number of results that can be returned.

  • workflowId — (String)

    The ID of the migration workflow.

  • stepGroupId — (String)

    The ID of the step group.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The pagination token.

    • workflowStepsSummary — (Array<map>)

      The summary of steps in a migration workflow.

      • stepId — (String)

        The ID of the step.

      • name — (String)

        The name of the step.

      • stepActionType — (String)

        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.

        Possible values include:
        • "MANUAL"
        • "AUTOMATED"
      • owner — (String)

        The owner of the step.

        Possible values include:
        • "AWS_MANAGED"
        • "CUSTOM"
      • previous — (Array<String>)

        The previous step.

      • next — (Array<String>)

        The next step.

      • status — (String)

        The status of the step.

        Possible values include:
        • "AWAITING_DEPENDENCIES"
        • "SKIPPED"
        • "READY"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "PAUSED"
        • "USER_ATTENTION_REQUIRED"
      • statusMessage — (String)

        The status message of the migration workflow.

      • noOfSrvCompleted — (Integer)

        The number of servers that have been migrated.

      • noOfSrvFailed — (Integer)

        The number of servers that have failed to migrate.

      • totalNoOfSrv — (Integer)

        The total number of servers that have been migrated.

      • description — (String)

        The description of the step.

      • scriptLocation — (String)

        The location of the script.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  stepGroupId: 'STRING_VALUE', /* required */
  workflowId: 'STRING_VALUE' /* required */
};
migrationhuborchestrator.retryWorkflowStep(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • workflowId — (String)

    The ID of the migration workflow.

  • stepGroupId — (String)

    The ID of the step group.

  • id — (String)

    The ID of the step.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • stepGroupId — (String)

      The ID of the step group.

    • workflowId — (String)

      The ID of the migration workflow.

    • id — (String)

      The ID of the step.

    • status — (String)

      The status of the step.

      Possible values include:
      • "AWAITING_DEPENDENCIES"
      • "SKIPPED"
      • "READY"
      • "IN_PROGRESS"
      • "COMPLETED"
      • "FAILED"
      • "PAUSED"
      • "USER_ATTENTION_REQUIRED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
migrationhuborchestrator.startWorkflow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The ID of the migration workflow.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      The ID of the migration workflow.

    • arn — (String)

      The Amazon Resource Name (ARN) of the migration workflow.

    • status — (String)

      The status of the migration workflow.

      Possible values include:
      • "CREATING"
      • "NOT_STARTED"
      • "CREATION_FAILED"
      • "STARTING"
      • "IN_PROGRESS"
      • "WORKFLOW_FAILED"
      • "PAUSED"
      • "PAUSING"
      • "PAUSING_FAILED"
      • "USER_ATTENTION_REQUIRED"
      • "DELETING"
      • "DELETION_FAILED"
      • "DELETED"
      • "COMPLETED"
    • statusMessage — (String)

      The status message of the migration workflow.

    • lastStartTime — (Date)

      The time at which the migration workflow was last started.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
migrationhuborchestrator.stopWorkflow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The ID of the migration workflow.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      The ID of the migration workflow.

    • arn — (String)

      The Amazon Resource Name (ARN) of the migration workflow.

    • status — (String)

      The status of the migration workflow.

      Possible values include:
      • "CREATING"
      • "NOT_STARTED"
      • "CREATION_FAILED"
      • "STARTING"
      • "IN_PROGRESS"
      • "WORKFLOW_FAILED"
      • "PAUSED"
      • "PAUSING"
      • "PAUSING_FAILED"
      • "USER_ATTENTION_REQUIRED"
      • "DELETING"
      • "DELETION_FAILED"
      • "DELETED"
      • "COMPLETED"
    • statusMessage — (String)

      The status message of the migration workflow.

    • lastStopTime — (Date)

      The time at which the migration workflow was stopped.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
migrationhuborchestrator.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the resource to which you want to add tags.

  • tags — (map<String>)

    A collection of labels, in the form of key:value pairs, that apply to this resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
migrationhuborchestrator.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the resource from which you want to remove tags.

  • tagKeys — (Array<String>)

    One or more tag keys. Specify only the tag keys, not the tag values.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  templateDescription: 'STRING_VALUE',
  templateName: 'STRING_VALUE'
};
migrationhuborchestrator.updateTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The ID of the request to update a migration workflow template.

  • templateName — (String)

    The name of the migration workflow template to update.

  • templateDescription — (String)

    The description of the migration workflow template to update.

  • clientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • templateId — (String)

      The ID of the migration workflow template being updated.

    • templateArn — (String)

      The ARN of the migration workflow template being updated. 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.

    • tags — (map<String>)

      The tags added to the migration workflow template.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  inputParameters: {
    '<StepInputParametersKey>': {
      integerValue: 'NUMBER_VALUE',
      listOfStringsValue: [
        'STRING_VALUE',
        /* more items */
      ],
      mapOfStringValue: {
        '<StringMapKey>': 'STRING_VALUE',
        /* '<StringMapKey>': ... */
      },
      stringValue: 'STRING_VALUE'
    },
    /* '<StepInputParametersKey>': ... */
  },
  name: 'STRING_VALUE',
  stepTargets: [
    'STRING_VALUE',
    /* more items */
  ]
};
migrationhuborchestrator.updateWorkflow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The ID of the migration workflow.

  • name — (String)

    The name of the migration workflow.

  • description — (String)

    The description of the migration workflow.

  • inputParameters — (map<map>)

    The input parameters required to update a migration workflow.

    • integerValue — (Integer)

      The value of the integer.

    • stringValue — (String)

      String value.

    • listOfStringsValue — (Array<String>)

      List of string values.

    • mapOfStringValue — (map<String>)

      Map of string values.

  • stepTargets — (Array<String>)

    The servers on which a step will be run.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      The ID of the migration workflow.

    • arn — (String)

      The Amazon Resource Name (ARN) of the migration workflow.

    • name — (String)

      The name of the migration workflow.

    • description — (String)

      The description of the migration workflow.

    • templateId — (String)

      The ID of the template.

    • adsApplicationConfigurationId — (String)

      The ID of the application configured in Application Discovery Service.

    • workflowInputs — (map<map>)

      The inputs required to update a migration workflow.

      • integerValue — (Integer)

        The value of the integer.

      • stringValue — (String)

        String value.

      • listOfStringsValue — (Array<String>)

        List of string values.

      • mapOfStringValue — (map<String>)

        Map of string values.

    • stepTargets — (Array<String>)

      The servers on which a step will be run.

    • status — (String)

      The status of the migration workflow.

      Possible values include:
      • "CREATING"
      • "NOT_STARTED"
      • "CREATION_FAILED"
      • "STARTING"
      • "IN_PROGRESS"
      • "WORKFLOW_FAILED"
      • "PAUSED"
      • "PAUSING"
      • "PAUSING_FAILED"
      • "USER_ATTENTION_REQUIRED"
      • "DELETING"
      • "DELETION_FAILED"
      • "DELETED"
      • "COMPLETED"
    • creationTime — (Date)

      The time at which the migration workflow was created.

    • lastModifiedTime — (Date)

      The time at which the migration workflow was last modified.

    • tags — (map<String>)

      The tags added to the migration workflow.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  stepGroupId: 'STRING_VALUE', /* required */
  workflowId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  name: 'STRING_VALUE',
  next: [
    'STRING_VALUE',
    /* more items */
  ],
  outputs: [
    {
      dataType: STRING | INTEGER | STRINGLIST | STRINGMAP,
      name: 'STRING_VALUE',
      required: true || false,
      value: {
        integerValue: 'NUMBER_VALUE',
        listOfStringValue: [
          'STRING_VALUE',
          /* more items */
        ],
        stringValue: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  previous: [
    'STRING_VALUE',
    /* more items */
  ],
  status: AWAITING_DEPENDENCIES | SKIPPED | READY | IN_PROGRESS | COMPLETED | FAILED | PAUSED | USER_ATTENTION_REQUIRED,
  stepActionType: MANUAL | AUTOMATED,
  stepTarget: [
    'STRING_VALUE',
    /* more items */
  ],
  workflowStepAutomationConfiguration: {
    command: {
      linux: 'STRING_VALUE',
      windows: 'STRING_VALUE'
    },
    runEnvironment: AWS | ONPREMISE,
    scriptLocationS3Bucket: 'STRING_VALUE',
    scriptLocationS3Key: {
      linux: 'STRING_VALUE',
      windows: 'STRING_VALUE'
    },
    targetType: SINGLE | ALL | NONE
  }
};
migrationhuborchestrator.updateWorkflowStep(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The ID of the step.

  • stepGroupId — (String)

    The ID of the step group.

  • workflowId — (String)

    The ID of the migration workflow.

  • name — (String)

    The name of the step.

  • description — (String)

    The description of the step.

  • stepActionType — (String)

    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.

    Possible values include:
    • "MANUAL"
    • "AUTOMATED"
  • workflowStepAutomationConfiguration — (map)

    The custom script to run tests on the source and target environments.

    • scriptLocationS3Bucket — (String)

      The Amazon S3 bucket where the script is located.

    • scriptLocationS3Key — (map)

      The Amazon S3 key for the script location.

      • linux — (String)

        The script location for Linux.

      • windows — (String)

        The script location for Windows.

    • command — (map)

      The command required to run the script.

      • linux — (String)

        Command for Linux.

      • windows — (String)

        Command for Windows.

    • runEnvironment — (String)

      The source or target environment.

      Possible values include:
      • "AWS"
      • "ONPREMISE"
    • targetType — (String)

      The servers on which to run the script.

      Possible values include:
      • "SINGLE"
      • "ALL"
      • "NONE"
  • stepTarget — (Array<String>)

    The servers on which a step will be run.

  • outputs — (Array<map>)

    The outputs of a step.

    • name — (String)

      The name of the step.

    • dataType — (String)

      The data type of the output.

      Possible values include:
      • "STRING"
      • "INTEGER"
      • "STRINGLIST"
      • "STRINGMAP"
    • required — (Boolean)

      Determine if an output is required from a step.

    • value — (map)

      The value of the output.

      • integerValue — (Integer)

        The integer value.

      • stringValue — (String)

        The string value.

      • listOfStringValue — (Array<String>)

        The list of string value.

  • previous — (Array<String>)

    The previous step.

  • next — (Array<String>)

    The next step.

  • status — (String)

    The status of the step.

    Possible values include:
    • "AWAITING_DEPENDENCIES"
    • "SKIPPED"
    • "READY"
    • "IN_PROGRESS"
    • "COMPLETED"
    • "FAILED"
    • "PAUSED"
    • "USER_ATTENTION_REQUIRED"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      The ID of the step.

    • stepGroupId — (String)

      The ID of the step group.

    • workflowId — (String)

      The ID of the migration workflow.

    • name — (String)

      The name of the step.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  workflowId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  name: 'STRING_VALUE',
  next: [
    'STRING_VALUE',
    /* more items */
  ],
  previous: [
    'STRING_VALUE',
    /* more items */
  ]
};
migrationhuborchestrator.updateWorkflowStepGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • workflowId — (String)

    The ID of the migration workflow.

  • id — (String)

    The ID of the step group.

  • name — (String)

    The name of the step group.

  • description — (String)

    The description of the step group.

  • next — (Array<String>)

    The next step group.

  • previous — (Array<String>)

    The previous step group.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • workflowId — (String)

      The ID of the migration workflow.

    • name — (String)

      The name of the step group.

    • id — (String)

      The ID of the step group.

    • description — (String)

      The description of the step group.

    • tools — (Array<map>)

      List of AWS services utilized in a migration workflow.

      • name — (String)

        The name of an AWS service.

      • url — (String)

        The URL of an AWS service.

    • next — (Array<String>)

      The next step group.

    • previous — (Array<String>)

      The previous step group.

    • lastModifiedTime — (Date)

      The time at which the step group was last modified.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Parameters:

• state (String) —

  the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

• params (map) (defaults to: {}) —

  a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

• function(err, data) { ... }

  Callback containing error and data information. See the respective resource state for the expected error or data information.

  If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.