SDK for PHP V3

AWS Migration Hub Orchestrator 2021-08-28

Client: Aws\MigrationHubOrchestrator\MigrationHubOrchestratorClient
Service ID: migrationhuborchestrator
Version: 2021-08-28

This page describes the parameters and results for the operations of the AWS Migration Hub Orchestrator (2021-08-28), and shows how to use the Aws\MigrationHubOrchestrator\MigrationHubOrchestratorClient object to call the described operations. This documentation is specific to the 2021-08-28 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateTemplate ( array $params = [] )
Creates a migration workflow template.
CreateWorkflow ( array $params = [] )
Create a workflow to orchestrate your migrations.
CreateWorkflowStep ( array $params = [] )
Create a step in the migration workflow.
CreateWorkflowStepGroup ( array $params = [] )
Create a step group in a migration workflow.
DeleteTemplate ( array $params = [] )
Deletes a migration workflow template.
DeleteWorkflow ( array $params = [] )
Delete a migration workflow.
DeleteWorkflowStep ( array $params = [] )
Delete a step in a migration workflow.
DeleteWorkflowStepGroup ( array $params = [] )
Delete a step group in a migration workflow.
GetTemplate ( array $params = [] )
Get the template you want to use for creating a migration workflow.
GetTemplateStep ( array $params = [] )
Get a specific step in a template.
GetTemplateStepGroup ( array $params = [] )
Get a step group in a template.
GetWorkflow ( array $params = [] )
Get migration workflow.
GetWorkflowStep ( array $params = [] )
Get a step in the migration workflow.
GetWorkflowStepGroup ( array $params = [] )
Get the step group of a migration workflow.
ListPlugins ( array $params = [] )
List AWS Migration Hub Orchestrator plugins.
ListTagsForResource ( array $params = [] )
List the tags added to a resource.
ListTemplateStepGroups ( array $params = [] )
List the step groups in a template.
ListTemplateSteps ( array $params = [] )
List the steps in a template.
ListTemplates ( array $params = [] )
List the templates available in Migration Hub Orchestrator to create a migration workflow.
ListWorkflowStepGroups ( array $params = [] )
List the step groups in a migration workflow.
ListWorkflowSteps ( array $params = [] )
List the steps in a workflow.
ListWorkflows ( array $params = [] )
List the migration workflows.
RetryWorkflowStep ( array $params = [] )
Retry a failed step in a migration workflow.
StartWorkflow ( array $params = [] )
Start a migration workflow.
StopWorkflow ( array $params = [] )
Stop an ongoing migration workflow.
TagResource ( array $params = [] )
Tag a resource by specifying its Amazon Resource Name (ARN).
UntagResource ( array $params = [] )
Deletes the tags for a resource.
UpdateTemplate ( array $params = [] )
Updates a migration workflow template.
UpdateWorkflow ( array $params = [] )
Update a migration workflow.
UpdateWorkflowStep ( array $params = [] )
Update a step in a migration workflow.
UpdateWorkflowStepGroup ( array $params = [] )
Update the step group in a migration workflow.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListPlugins
ListTemplateStepGroups
ListTemplateSteps
ListTemplates
ListWorkflowStepGroups
ListWorkflowSteps
ListWorkflows

Operations

CreateTemplate 

$result = $client->createTemplate([/* ... */]);
$promise = $client->createTemplateAsync([/* ... */]);

Creates a migration workflow template.

Parameter Syntax

$result = $client->createTemplate([
    'clientToken' => '<string>',
    'tags' => ['<string>', ...],
    'templateDescription' => '<string>',
    'templateName' => '<string>', // REQUIRED
    'templateSource' => [ // REQUIRED
        'workflowId' => '<string>',
    ],
]);

Parameter Details

Members
clientToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Idempotency in the Smithy documentation.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags to add to the migration workflow template.

templateDescription
Type: string

A description of the migration workflow template.

templateName
Required: Yes
Type: string

The name of the migration workflow template.

templateSource
Required: Yes
Type: TemplateSource structure

The source of the migration workflow template.

Result Syntax

[
    'tags' => ['<string>', ...],
    'templateArn' => '<string>',
    'templateId' => '<string>',
]

Result Details

Members
tags
Type: Associative array of custom strings keys (StringMapKey) to strings

The tags added to the migration workflow template.

templateArn
Type: 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.

templateId
Type: string

The ID of the migration workflow template.

Errors

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

This exception is thrown when an attempt to update or delete a resource would cause an inconsistent state.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

CreateWorkflow 

$result = $client->createWorkflow([/* ... */]);
$promise = $client->createWorkflowAsync([/* ... */]);

Create a workflow to orchestrate your migrations.

Parameter Syntax

$result = $client->createWorkflow([
    'applicationConfigurationId' => '<string>',
    'description' => '<string>',
    'inputParameters' => [ // REQUIRED
        '<StepInputParametersKey>' => [
            'integerValue' => <integer>,
            'listOfStringsValue' => ['<string>', ...],
            'mapOfStringValue' => ['<string>', ...],
            'stringValue' => '<string>',
        ],
        // ...
    ],
    'name' => '<string>', // REQUIRED
    'stepTargets' => ['<string>', ...],
    'tags' => ['<string>', ...],
    'templateId' => '<string>', // REQUIRED
]);

Parameter Details

Members
applicationConfigurationId
Type: string

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

description
Type: string

The description of the migration workflow.

inputParameters
Required: Yes
Type: Associative array of custom strings keys (StepInputParametersKey) to StepInput structures

The input parameters required to create a migration workflow.

name
Required: Yes
Type: string

The name of the migration workflow.

stepTargets
Type: Array of strings

The servers on which a step will be run.

tags
Type: Associative array of custom strings keys (StringMapKey) to strings

The tags to add on a migration workflow.

templateId
Required: Yes
Type: string

The ID of the template.

Result Syntax

[
    'adsApplicationConfigurationId' => '<string>',
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'status' => 'CREATING|NOT_STARTED|CREATION_FAILED|STARTING|IN_PROGRESS|WORKFLOW_FAILED|PAUSED|PAUSING|PAUSING_FAILED|USER_ATTENTION_REQUIRED|DELETING|DELETION_FAILED|DELETED|COMPLETED',
    'stepTargets' => ['<string>', ...],
    'tags' => ['<string>', ...],
    'templateId' => '<string>',
    'workflowInputs' => [
        '<StepInputParametersKey>' => [
            'integerValue' => <integer>,
            'listOfStringsValue' => ['<string>', ...],
            'mapOfStringValue' => ['<string>', ...],
            'stringValue' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
adsApplicationConfigurationId
Type: string

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

arn
Type: string

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

creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the migration workflow was created.

description
Type: string

The description of the migration workflow.

id
Type: string

The ID of the migration workflow.

name
Type: string

The name of the migration workflow.

status
Type: string

The status of the migration workflow.

stepTargets
Type: Array of strings

The servers on which a step will be run.

tags
Type: Associative array of custom strings keys (StringMapKey) to strings

The tags to add on a migration workflow.

templateId
Type: string

The ID of the template.

workflowInputs
Type: Associative array of custom strings keys (StepInputParametersKey) to StepInput structures

The inputs for creating a migration workflow.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

CreateWorkflowStep 

$result = $client->createWorkflowStep([/* ... */]);
$promise = $client->createWorkflowStepAsync([/* ... */]);

Create a step in the migration workflow.

Parameter Syntax

$result = $client->createWorkflowStep([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'next' => ['<string>', ...],
    'outputs' => [
        [
            'dataType' => 'STRING|INTEGER|STRINGLIST|STRINGMAP',
            'name' => '<string>',
            'required' => true || false,
            'value' => [
                'integerValue' => <integer>,
                'listOfStringValue' => ['<string>', ...],
                'stringValue' => '<string>',
            ],
        ],
        // ...
    ],
    'previous' => ['<string>', ...],
    'stepActionType' => 'MANUAL|AUTOMATED', // REQUIRED
    'stepGroupId' => '<string>', // REQUIRED
    'stepTarget' => ['<string>', ...],
    'workflowId' => '<string>', // REQUIRED
    'workflowStepAutomationConfiguration' => [
        'command' => [
            'linux' => '<string>',
            'windows' => '<string>',
        ],
        'runEnvironment' => 'AWS|ONPREMISE',
        'scriptLocationS3Bucket' => '<string>',
        'scriptLocationS3Key' => [
            'linux' => '<string>',
            'windows' => '<string>',
        ],
        'targetType' => 'SINGLE|ALL|NONE',
    ],
]);

Parameter Details

Members
description
Type: string

The description of the step.

name
Required: Yes
Type: string

The name of the step.

next
Type: Array of strings

The next step.

outputs
Type: Array of WorkflowStepOutput structures

The key value pairs added for the expected output.

previous
Type: Array of strings

The previous step.

stepActionType
Required: Yes
Type: 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.

stepGroupId
Required: Yes
Type: string

The ID of the step group.

stepTarget
Type: Array of strings

The servers on which a step will be run.

workflowId
Required: Yes
Type: string

The ID of the migration workflow.

workflowStepAutomationConfiguration
Type: WorkflowStepAutomationConfiguration structure

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

Result Syntax

[
    'id' => '<string>',
    'name' => '<string>',
    'stepGroupId' => '<string>',
    'workflowId' => '<string>',
]

Result Details

Members
id
Type: string

The ID of the step.

name
Type: string

The name of the step.

stepGroupId
Type: string

The ID of the step group.

workflowId
Type: string

The ID of the migration workflow.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

CreateWorkflowStepGroup 

$result = $client->createWorkflowStepGroup([/* ... */]);
$promise = $client->createWorkflowStepGroupAsync([/* ... */]);

Create a step group in a migration workflow.

Parameter Syntax

$result = $client->createWorkflowStepGroup([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'next' => ['<string>', ...],
    'previous' => ['<string>', ...],
    'workflowId' => '<string>', // REQUIRED
]);

Parameter Details

Members
description
Type: string

The description of the step group.

name
Required: Yes
Type: string

The name of the step group.

next
Type: Array of strings

The next step group.

previous
Type: Array of strings

The previous step group.

workflowId
Required: Yes
Type: string

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

Result Syntax

[
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'next' => ['<string>', ...],
    'previous' => ['<string>', ...],
    'tools' => [
        [
            'name' => '<string>',
            'url' => '<string>',
        ],
        // ...
    ],
    'workflowId' => '<string>',
]

Result Details

Members
creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the step group is created.

description
Type: string

The description of the step group.

id
Type: string

The ID of the step group.

name
Type: string

The name of the step group.

next
Type: Array of strings

The next step group.

previous
Type: Array of strings

The previous step group.

tools
Type: Array of Tool structures

List of AWS services utilized in a migration workflow.

workflowId
Type: string

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

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

DeleteTemplate 

$result = $client->deleteTemplate([/* ... */]);
$promise = $client->deleteTemplateAsync([/* ... */]);

Deletes a migration workflow template.

Parameter Syntax

$result = $client->deleteTemplate([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

ResourceNotFoundException:

The resource is not available.

DeleteWorkflow 

$result = $client->deleteWorkflow([/* ... */]);
$promise = $client->deleteWorkflowAsync([/* ... */]);

Delete a migration workflow. You must pause a running workflow in Migration Hub Orchestrator console to delete it.

Parameter Syntax

$result = $client->deleteWorkflow([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the migration workflow you want to delete.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'status' => 'CREATING|NOT_STARTED|CREATION_FAILED|STARTING|IN_PROGRESS|WORKFLOW_FAILED|PAUSED|PAUSING|PAUSING_FAILED|USER_ATTENTION_REQUIRED|DELETING|DELETION_FAILED|DELETED|COMPLETED',
]

Result Details

Members
arn
Type: string

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

id
Type: string

The ID of the migration workflow.

status
Type: string

The status of the migration workflow.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

ResourceNotFoundException:

The resource is not available.

DeleteWorkflowStep 

$result = $client->deleteWorkflowStep([/* ... */]);
$promise = $client->deleteWorkflowStepAsync([/* ... */]);

Delete a step in a migration workflow. Pause the workflow to delete a running step.

Parameter Syntax

$result = $client->deleteWorkflowStep([
    'id' => '<string>', // REQUIRED
    'stepGroupId' => '<string>', // REQUIRED
    'workflowId' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the step you want to delete.

stepGroupId
Required: Yes
Type: string

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

workflowId
Required: Yes
Type: string

The ID of the migration workflow.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

ResourceNotFoundException:

The resource is not available.

DeleteWorkflowStepGroup 

$result = $client->deleteWorkflowStepGroup([/* ... */]);
$promise = $client->deleteWorkflowStepGroupAsync([/* ... */]);

Delete a step group in a migration workflow.

Parameter Syntax

$result = $client->deleteWorkflowStepGroup([
    'id' => '<string>', // REQUIRED
    'workflowId' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the step group you want to delete.

workflowId
Required: Yes
Type: string

The ID of the migration workflow.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

ResourceNotFoundException:

The resource is not available.

GetTemplate 

$result = $client->getTemplate([/* ... */]);
$promise = $client->getTemplateAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getTemplate([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the template.

Result Syntax

[
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'id' => '<string>',
    'inputs' => [
        [
            'dataType' => 'STRING|INTEGER|STRINGLIST|STRINGMAP',
            'inputName' => '<string>',
            'required' => true || false,
        ],
        // ...
    ],
    'name' => '<string>',
    'owner' => '<string>',
    'status' => 'CREATED|READY|PENDING_CREATION|CREATING|CREATION_FAILED',
    'statusMessage' => '<string>',
    'tags' => ['<string>', ...],
    'templateArn' => '<string>',
    'templateClass' => '<string>',
    'tools' => [
        [
            'name' => '<string>',
            'url' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the template was last created.

description
Type: string

The time at which the template was last created.

id
Type: string

The ID of the template.

inputs
Type: Array of TemplateInput structures

The inputs provided for the creation of the migration workflow.

name
Type: string

The name of the template.

owner
Type: string

The owner of the migration workflow template.

status
Type: string

The status of the template.

statusMessage
Type: string

The status message of retrieving migration workflow templates.

tags
Type: Associative array of custom strings keys (StringMapKey) to strings

The tags added to the migration workflow template.

templateArn
Type: 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.

templateClass
Type: string

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

  • A2C

  • MGN

  • SAP_MULTI

  • SQL_EC2

  • SQL_RDS

  • VMIE

tools
Type: Array of Tool structures

List of AWS services utilized in a migration workflow.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ResourceNotFoundException:

The resource is not available.

GetTemplateStep 

$result = $client->getTemplateStep([/* ... */]);
$promise = $client->getTemplateStepAsync([/* ... */]);

Get a specific step in a template.

Parameter Syntax

$result = $client->getTemplateStep([
    'id' => '<string>', // REQUIRED
    'stepGroupId' => '<string>', // REQUIRED
    'templateId' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the step.

stepGroupId
Required: Yes
Type: string

The ID of the step group.

templateId
Required: Yes
Type: string

The ID of the template.

Result Syntax

[
    'creationTime' => '<string>',
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'next' => ['<string>', ...],
    'outputs' => [
        [
            'dataType' => 'STRING|INTEGER|STRINGLIST|STRINGMAP',
            'name' => '<string>',
            'required' => true || false,
        ],
        // ...
    ],
    'previous' => ['<string>', ...],
    'stepActionType' => 'MANUAL|AUTOMATED',
    'stepAutomationConfiguration' => [
        'command' => [
            'linux' => '<string>',
            'windows' => '<string>',
        ],
        'runEnvironment' => 'AWS|ONPREMISE',
        'scriptLocationS3Bucket' => '<string>',
        'scriptLocationS3Key' => [
            'linux' => '<string>',
            'windows' => '<string>',
        ],
        'targetType' => 'SINGLE|ALL|NONE',
    ],
    'stepGroupId' => '<string>',
    'templateId' => '<string>',
]

Result Details

Members
creationTime
Type: string

The time at which the step was created.

description
Type: string

The description of the step.

id
Type: string

The ID of the step.

name
Type: string

The name of the step.

next
Type: Array of strings

The next step.

outputs
Type: Array of StepOutput structures

The outputs of the step.

previous
Type: Array of strings

The previous step.

stepActionType
Type: 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.

stepAutomationConfiguration
Type: StepAutomationConfiguration structure

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

stepGroupId
Type: string

The ID of the step group.

templateId
Type: string

The ID of the template.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

ResourceNotFoundException:

The resource is not available.

GetTemplateStepGroup 

$result = $client->getTemplateStepGroup([/* ... */]);
$promise = $client->getTemplateStepGroupAsync([/* ... */]);

Get a step group in a template.

Parameter Syntax

$result = $client->getTemplateStepGroup([
    'id' => '<string>', // REQUIRED
    'templateId' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the step group.

templateId
Required: Yes
Type: string

The ID of the template.

Result Syntax

[
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'id' => '<string>',
    'lastModifiedTime' => <DateTime>,
    'name' => '<string>',
    'next' => ['<string>', ...],
    'previous' => ['<string>', ...],
    'status' => 'AWAITING_DEPENDENCIES|READY|IN_PROGRESS|COMPLETED|FAILED|PAUSED|PAUSING|USER_ATTENTION_REQUIRED',
    'templateId' => '<string>',
    'tools' => [
        [
            'name' => '<string>',
            'url' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the step group was created.

description
Type: string

The description of the step group.

id
Type: string

The ID of the step group.

lastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the step group was last modified.

name
Type: string

The name of the step group.

next
Type: Array of strings

The next step group.

previous
Type: Array of strings

The previous step group.

status
Type: string

The status of the step group.

templateId
Type: string

The ID of the template.

tools
Type: Array of Tool structures

List of AWS services utilized in a migration workflow.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

ResourceNotFoundException:

The resource is not available.

GetWorkflow 

$result = $client->getWorkflow([/* ... */]);
$promise = $client->getWorkflowAsync([/* ... */]);

Get migration workflow.

Parameter Syntax

$result = $client->getWorkflow([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the migration workflow.

Result Syntax

[
    'adsApplicationConfigurationId' => '<string>',
    'adsApplicationName' => '<string>',
    'arn' => '<string>',
    'completedSteps' => <integer>,
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'endTime' => <DateTime>,
    'id' => '<string>',
    'lastModifiedTime' => <DateTime>,
    'lastStartTime' => <DateTime>,
    'lastStopTime' => <DateTime>,
    'name' => '<string>',
    'status' => 'CREATING|NOT_STARTED|CREATION_FAILED|STARTING|IN_PROGRESS|WORKFLOW_FAILED|PAUSED|PAUSING|PAUSING_FAILED|USER_ATTENTION_REQUIRED|DELETING|DELETION_FAILED|DELETED|COMPLETED',
    'statusMessage' => '<string>',
    'tags' => ['<string>', ...],
    'templateId' => '<string>',
    'tools' => [
        [
            'name' => '<string>',
            'url' => '<string>',
        ],
        // ...
    ],
    'totalSteps' => <integer>,
    'workflowBucket' => '<string>',
    'workflowInputs' => [
        '<StepInputParametersKey>' => [
            'integerValue' => <integer>,
            'listOfStringsValue' => ['<string>', ...],
            'mapOfStringValue' => ['<string>', ...],
            'stringValue' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
adsApplicationConfigurationId
Type: string

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

adsApplicationName
Type: string

The name of the application configured in Application Discovery Service.

arn
Type: string

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

completedSteps
Type: int

Get a list of completed steps in the migration workflow.

creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the migration workflow was created.

description
Type: string

The description of the migration workflow.

endTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the migration workflow ended.

id
Type: string

The ID of the migration workflow.

lastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the migration workflow was last modified.

lastStartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the migration workflow was last started.

lastStopTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the migration workflow was last stopped.

name
Type: string

The name of the migration workflow.

status
Type: string

The status of the migration workflow.

statusMessage
Type: string

The status message of the migration workflow.

tags
Type: Associative array of custom strings keys (StringMapKey) to strings

The tags added to the migration workflow.

templateId
Type: string

The ID of the template.

tools
Type: Array of Tool structures

List of AWS services utilized in a migration workflow.

totalSteps
Type: int

The total number of steps in the migration workflow.

workflowBucket
Type: string

The Amazon S3 bucket where the migration logs are stored.

workflowInputs
Type: Associative array of custom strings keys (StepInputParametersKey) to StepInput structures

The inputs required for creating the migration workflow.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

ResourceNotFoundException:

The resource is not available.

GetWorkflowStep 

$result = $client->getWorkflowStep([/* ... */]);
$promise = $client->getWorkflowStepAsync([/* ... */]);

Get a step in the migration workflow.

Parameter Syntax

$result = $client->getWorkflowStep([
    'id' => '<string>', // REQUIRED
    'stepGroupId' => '<string>', // REQUIRED
    'workflowId' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the step.

stepGroupId
Required: Yes
Type: string

The ID of the step group.

workflowId
Required: Yes
Type: string

The ID of the migration workflow.

Result Syntax

[
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'endTime' => <DateTime>,
    'lastStartTime' => <DateTime>,
    'name' => '<string>',
    'next' => ['<string>', ...],
    'noOfSrvCompleted' => <integer>,
    'noOfSrvFailed' => <integer>,
    'outputs' => [
        [
            'dataType' => 'STRING|INTEGER|STRINGLIST|STRINGMAP',
            'name' => '<string>',
            'required' => true || false,
            'value' => [
                'integerValue' => <integer>,
                'listOfStringValue' => ['<string>', ...],
                'stringValue' => '<string>',
            ],
        ],
        // ...
    ],
    'owner' => 'AWS_MANAGED|CUSTOM',
    'previous' => ['<string>', ...],
    'scriptOutputLocation' => '<string>',
    'status' => 'AWAITING_DEPENDENCIES|SKIPPED|READY|IN_PROGRESS|COMPLETED|FAILED|PAUSED|USER_ATTENTION_REQUIRED',
    'statusMessage' => '<string>',
    'stepActionType' => 'MANUAL|AUTOMATED',
    'stepGroupId' => '<string>',
    'stepId' => '<string>',
    'stepTarget' => ['<string>', ...],
    'totalNoOfSrv' => <integer>,
    'workflowId' => '<string>',
    'workflowStepAutomationConfiguration' => [
        'command' => [
            'linux' => '<string>',
            'windows' => '<string>',
        ],
        'runEnvironment' => 'AWS|ONPREMISE',
        'scriptLocationS3Bucket' => '<string>',
        'scriptLocationS3Key' => [
            'linux' => '<string>',
            'windows' => '<string>',
        ],
        'targetType' => 'SINGLE|ALL|NONE',
    ],
]

Result Details

Members
creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the step was created.

description
Type: string

The description of the step.

endTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the step ended.

lastStartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the workflow was last started.

name
Type: string

The name of the step.

next
Type: Array of strings

The next step.

noOfSrvCompleted
Type: int

The number of servers that have been migrated.

noOfSrvFailed
Type: int

The number of servers that have failed to migrate.

outputs
Type: Array of WorkflowStepOutput structures

The outputs of the step.

owner
Type: string

The owner of the step.

previous
Type: Array of strings

The previous step.

scriptOutputLocation
Type: string

The output location of the script.

status
Type: string

The status of the step.

statusMessage
Type: string

The status message of the migration workflow.

stepActionType
Type: 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.

stepGroupId
Type: string

The ID of the step group.

stepId
Type: string

The ID of the step.

stepTarget
Type: Array of strings

The servers on which a step will be run.

totalNoOfSrv
Type: int

The total number of servers that have been migrated.

workflowId
Type: string

The ID of the migration workflow.

workflowStepAutomationConfiguration
Type: WorkflowStepAutomationConfiguration structure

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

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ResourceNotFoundException:

The resource is not available.

GetWorkflowStepGroup 

$result = $client->getWorkflowStepGroup([/* ... */]);
$promise = $client->getWorkflowStepGroupAsync([/* ... */]);

Get the step group of a migration workflow.

Parameter Syntax

$result = $client->getWorkflowStepGroup([
    'id' => '<string>', // REQUIRED
    'workflowId' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the step group.

workflowId
Required: Yes
Type: string

The ID of the migration workflow.

Result Syntax

[
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'endTime' => <DateTime>,
    'id' => '<string>',
    'lastModifiedTime' => <DateTime>,
    'name' => '<string>',
    'next' => ['<string>', ...],
    'owner' => 'AWS_MANAGED|CUSTOM',
    'previous' => ['<string>', ...],
    'status' => 'AWAITING_DEPENDENCIES|READY|IN_PROGRESS|COMPLETED|FAILED|PAUSED|PAUSING|USER_ATTENTION_REQUIRED',
    'tools' => [
        [
            'name' => '<string>',
            'url' => '<string>',
        ],
        // ...
    ],
    'workflowId' => '<string>',
]

Result Details

Members
creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the step group was created.

description
Type: string

The description of the step group.

endTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the step group ended.

id
Type: string

The ID of the step group.

lastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the step group was last modified.

name
Type: string

The name of the step group.

next
Type: Array of strings

The next step group.

owner
Type: string

The owner of the step group.

previous
Type: Array of strings

The previous step group.

status
Type: string

The status of the step group.

tools
Type: Array of Tool structures

List of AWS services utilized in a migration workflow.

workflowId
Type: string

The ID of the migration workflow.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

ResourceNotFoundException:

The resource is not available.

ListPlugins 

$result = $client->listPlugins([/* ... */]);
$promise = $client->listPluginsAsync([/* ... */]);

List AWS Migration Hub Orchestrator plugins.

Parameter Syntax

$result = $client->listPlugins([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of plugins that can be returned.

nextToken
Type: string

The pagination token.

Result Syntax

[
    'nextToken' => '<string>',
    'plugins' => [
        [
            'hostname' => '<string>',
            'ipAddress' => '<string>',
            'pluginId' => '<string>',
            'registeredTime' => '<string>',
            'status' => 'HEALTHY|UNHEALTHY',
            'version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The pagination token.

plugins
Type: Array of PluginSummary structures

Migration Hub Orchestrator plugins.

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

ListTagsForResource 

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

List the tags added to a resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags added to a resource.

Errors

ValidationException:

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

ResourceNotFoundException:

The resource is not available.

ListTemplateStepGroups 

$result = $client->listTemplateStepGroups([/* ... */]);
$promise = $client->listTemplateStepGroupsAsync([/* ... */]);

List the step groups in a template.

Parameter Syntax

$result = $client->listTemplateStepGroups([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'templateId' => '<string>', // REQUIRED
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of results that can be returned.

nextToken
Type: string

The pagination token.

templateId
Required: Yes
Type: string

The ID of the template.

Result Syntax

[
    'nextToken' => '<string>',
    'templateStepGroupSummary' => [
        [
            'id' => '<string>',
            'name' => '<string>',
            'next' => ['<string>', ...],
            'previous' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The pagination token.

templateStepGroupSummary
Required: Yes
Type: Array of TemplateStepGroupSummary structures

The summary of the step group in the template.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ResourceNotFoundException:

The resource is not available.

ListTemplateSteps 

$result = $client->listTemplateSteps([/* ... */]);
$promise = $client->listTemplateStepsAsync([/* ... */]);

List the steps in a template.

Parameter Syntax

$result = $client->listTemplateSteps([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'stepGroupId' => '<string>', // REQUIRED
    'templateId' => '<string>', // REQUIRED
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of results that can be returned.

nextToken
Type: string

The pagination token.

stepGroupId
Required: Yes
Type: string

The ID of the step group.

templateId
Required: Yes
Type: string

The ID of the template.

Result Syntax

[
    'nextToken' => '<string>',
    'templateStepSummaryList' => [
        [
            'id' => '<string>',
            'name' => '<string>',
            'next' => ['<string>', ...],
            'owner' => 'AWS_MANAGED|CUSTOM',
            'previous' => ['<string>', ...],
            'stepActionType' => 'MANUAL|AUTOMATED',
            'stepGroupId' => '<string>',
            'targetType' => 'SINGLE|ALL|NONE',
            'templateId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The pagination token.

templateStepSummaryList
Type: Array of TemplateStepSummary structures

The list of summaries of steps in a template.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

ResourceNotFoundException:

The resource is not available.

ListTemplates 

$result = $client->listTemplates([/* ... */]);
$promise = $client->listTemplatesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTemplates([
    'maxResults' => <integer>,
    'name' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of results that can be returned.

name
Type: string

The name of the template.

nextToken
Type: string

The pagination token.

Result Syntax

[
    'nextToken' => '<string>',
    'templateSummary' => [
        [
            'arn' => '<string>',
            'description' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The pagination token.

templateSummary
Required: Yes
Type: Array of TemplateSummary structures

The summary of the template.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ListWorkflowStepGroups 

$result = $client->listWorkflowStepGroups([/* ... */]);
$promise = $client->listWorkflowStepGroupsAsync([/* ... */]);

List the step groups in a migration workflow.

Parameter Syntax

$result = $client->listWorkflowStepGroups([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'workflowId' => '<string>', // REQUIRED
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of results that can be returned.

nextToken
Type: string

The pagination token.

workflowId
Required: Yes
Type: string

The ID of the migration workflow.

Result Syntax

[
    'nextToken' => '<string>',
    'workflowStepGroupsSummary' => [
        [
            'id' => '<string>',
            'name' => '<string>',
            'next' => ['<string>', ...],
            'owner' => 'AWS_MANAGED|CUSTOM',
            'previous' => ['<string>', ...],
            'status' => 'AWAITING_DEPENDENCIES|READY|IN_PROGRESS|COMPLETED|FAILED|PAUSED|PAUSING|USER_ATTENTION_REQUIRED',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The pagination token.

workflowStepGroupsSummary
Required: Yes
Type: Array of WorkflowStepGroupSummary structures

The summary of step groups in a migration workflow.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

ResourceNotFoundException:

The resource is not available.

ListWorkflowSteps 

$result = $client->listWorkflowSteps([/* ... */]);
$promise = $client->listWorkflowStepsAsync([/* ... */]);

List the steps in a workflow.

Parameter Syntax

$result = $client->listWorkflowSteps([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'stepGroupId' => '<string>', // REQUIRED
    'workflowId' => '<string>', // REQUIRED
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of results that can be returned.

nextToken
Type: string

The pagination token.

stepGroupId
Required: Yes
Type: string

The ID of the step group.

workflowId
Required: Yes
Type: string

The ID of the migration workflow.

Result Syntax

[
    'nextToken' => '<string>',
    'workflowStepsSummary' => [
        [
            'description' => '<string>',
            'name' => '<string>',
            'next' => ['<string>', ...],
            'noOfSrvCompleted' => <integer>,
            'noOfSrvFailed' => <integer>,
            'owner' => 'AWS_MANAGED|CUSTOM',
            'previous' => ['<string>', ...],
            'scriptLocation' => '<string>',
            'status' => 'AWAITING_DEPENDENCIES|SKIPPED|READY|IN_PROGRESS|COMPLETED|FAILED|PAUSED|USER_ATTENTION_REQUIRED',
            'statusMessage' => '<string>',
            'stepActionType' => 'MANUAL|AUTOMATED',
            'stepId' => '<string>',
            'totalNoOfSrv' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The pagination token.

workflowStepsSummary
Required: Yes
Type: Array of WorkflowStepSummary structures

The summary of steps in a migration workflow.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

ListWorkflows 

$result = $client->listWorkflows([/* ... */]);
$promise = $client->listWorkflowsAsync([/* ... */]);

List the migration workflows.

Parameter Syntax

$result = $client->listWorkflows([
    'adsApplicationConfigurationName' => '<string>',
    'maxResults' => <integer>,
    'name' => '<string>',
    'nextToken' => '<string>',
    '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>',
]);

Parameter Details

Members
adsApplicationConfigurationName
Type: string

The name of the application configured in Application Discovery Service.

maxResults
Type: int

The maximum number of results that can be returned.

name
Type: string

The name of the migration workflow.

nextToken
Type: string

The pagination token.

status
Type: string

The status of the migration workflow.

templateId
Type: string

The ID of the template.

Result Syntax

[
    'migrationWorkflowSummary' => [
        [
            'adsApplicationConfigurationName' => '<string>',
            'completedSteps' => <integer>,
            'creationTime' => <DateTime>,
            'endTime' => <DateTime>,
            'id' => '<string>',
            'name' => '<string>',
            'status' => 'CREATING|NOT_STARTED|CREATION_FAILED|STARTING|IN_PROGRESS|WORKFLOW_FAILED|PAUSED|PAUSING|PAUSING_FAILED|USER_ATTENTION_REQUIRED|DELETING|DELETION_FAILED|DELETED|COMPLETED',
            'statusMessage' => '<string>',
            'templateId' => '<string>',
            'totalSteps' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
migrationWorkflowSummary
Required: Yes
Type: Array of MigrationWorkflowSummary structures

The summary of the migration workflow.

nextToken
Type: string

The pagination token.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

ResourceNotFoundException:

The resource is not available.

RetryWorkflowStep 

$result = $client->retryWorkflowStep([/* ... */]);
$promise = $client->retryWorkflowStepAsync([/* ... */]);

Retry a failed step in a migration workflow.

Parameter Syntax

$result = $client->retryWorkflowStep([
    'id' => '<string>', // REQUIRED
    'stepGroupId' => '<string>', // REQUIRED
    'workflowId' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the step.

stepGroupId
Required: Yes
Type: string

The ID of the step group.

workflowId
Required: Yes
Type: string

The ID of the migration workflow.

Result Syntax

[
    'id' => '<string>',
    'status' => 'AWAITING_DEPENDENCIES|SKIPPED|READY|IN_PROGRESS|COMPLETED|FAILED|PAUSED|USER_ATTENTION_REQUIRED',
    'stepGroupId' => '<string>',
    'workflowId' => '<string>',
]

Result Details

Members
id
Type: string

The ID of the step.

status
Type: string

The status of the step.

stepGroupId
Type: string

The ID of the step group.

workflowId
Type: string

The ID of the migration workflow.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ResourceNotFoundException:

The resource is not available.

StartWorkflow 

$result = $client->startWorkflow([/* ... */]);
$promise = $client->startWorkflowAsync([/* ... */]);

Start a migration workflow.

Parameter Syntax

$result = $client->startWorkflow([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the migration workflow.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'lastStartTime' => <DateTime>,
    'status' => 'CREATING|NOT_STARTED|CREATION_FAILED|STARTING|IN_PROGRESS|WORKFLOW_FAILED|PAUSED|PAUSING|PAUSING_FAILED|USER_ATTENTION_REQUIRED|DELETING|DELETION_FAILED|DELETED|COMPLETED',
    'statusMessage' => '<string>',
]

Result Details

Members
arn
Type: string

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

id
Type: string

The ID of the migration workflow.

lastStartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the migration workflow was last started.

status
Type: string

The status of the migration workflow.

statusMessage
Type: string

The status message of the migration workflow.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

ResourceNotFoundException:

The resource is not available.

StopWorkflow 

$result = $client->stopWorkflow([/* ... */]);
$promise = $client->stopWorkflowAsync([/* ... */]);

Stop an ongoing migration workflow.

Parameter Syntax

$result = $client->stopWorkflow([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the migration workflow.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'lastStopTime' => <DateTime>,
    'status' => 'CREATING|NOT_STARTED|CREATION_FAILED|STARTING|IN_PROGRESS|WORKFLOW_FAILED|PAUSED|PAUSING|PAUSING_FAILED|USER_ATTENTION_REQUIRED|DELETING|DELETION_FAILED|DELETED|COMPLETED',
    'statusMessage' => '<string>',
]

Result Details

Members
arn
Type: string

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

id
Type: string

The ID of the migration workflow.

lastStopTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the migration workflow was stopped.

status
Type: string

The status of the migration workflow.

statusMessage
Type: string

The status message of the migration workflow.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

ResourceNotFoundException:

The resource is not available.

TagResource 

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Tag a resource by specifying its Amazon Resource Name (ARN).

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

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

tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

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

ResourceNotFoundException:

The resource is not available.

UntagResource 

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Deletes the tags for a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

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

tagKeys
Required: Yes
Type: Array of strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

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

ResourceNotFoundException:

The resource is not available.

UpdateTemplate 

$result = $client->updateTemplate([/* ... */]);
$promise = $client->updateTemplateAsync([/* ... */]);

Updates a migration workflow template.

Parameter Syntax

$result = $client->updateTemplate([
    'clientToken' => '<string>',
    'id' => '<string>', // REQUIRED
    'templateDescription' => '<string>',
    'templateName' => '<string>',
]);

Parameter Details

Members
clientToken
Type: string

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

id
Required: Yes
Type: string

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

templateDescription
Type: string

The description of the migration workflow template to update.

templateName
Type: string

The name of the migration workflow template to update.

Result Syntax

[
    'tags' => ['<string>', ...],
    'templateArn' => '<string>',
    'templateId' => '<string>',
]

Result Details

Members
tags
Type: Associative array of custom strings keys (StringMapKey) to strings

The tags added to the migration workflow template.

templateArn
Type: 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.

templateId
Type: string

The ID of the migration workflow template being updated.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

ResourceNotFoundException:

The resource is not available.

UpdateWorkflow 

$result = $client->updateWorkflow([/* ... */]);
$promise = $client->updateWorkflowAsync([/* ... */]);

Update a migration workflow.

Parameter Syntax

$result = $client->updateWorkflow([
    'description' => '<string>',
    'id' => '<string>', // REQUIRED
    'inputParameters' => [
        '<StepInputParametersKey>' => [
            'integerValue' => <integer>,
            'listOfStringsValue' => ['<string>', ...],
            'mapOfStringValue' => ['<string>', ...],
            'stringValue' => '<string>',
        ],
        // ...
    ],
    'name' => '<string>',
    'stepTargets' => ['<string>', ...],
]);

Parameter Details

Members
description
Type: string

The description of the migration workflow.

id
Required: Yes
Type: string

The ID of the migration workflow.

inputParameters
Type: Associative array of custom strings keys (StepInputParametersKey) to StepInput structures

The input parameters required to update a migration workflow.

name
Type: string

The name of the migration workflow.

stepTargets
Type: Array of strings

The servers on which a step will be run.

Result Syntax

[
    'adsApplicationConfigurationId' => '<string>',
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'id' => '<string>',
    'lastModifiedTime' => <DateTime>,
    'name' => '<string>',
    'status' => 'CREATING|NOT_STARTED|CREATION_FAILED|STARTING|IN_PROGRESS|WORKFLOW_FAILED|PAUSED|PAUSING|PAUSING_FAILED|USER_ATTENTION_REQUIRED|DELETING|DELETION_FAILED|DELETED|COMPLETED',
    'stepTargets' => ['<string>', ...],
    'tags' => ['<string>', ...],
    'templateId' => '<string>',
    'workflowInputs' => [
        '<StepInputParametersKey>' => [
            'integerValue' => <integer>,
            'listOfStringsValue' => ['<string>', ...],
            'mapOfStringValue' => ['<string>', ...],
            'stringValue' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
adsApplicationConfigurationId
Type: string

The ID of the application configured in Application Discovery Service.

arn
Type: string

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

creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the migration workflow was created.

description
Type: string

The description of the migration workflow.

id
Type: string

The ID of the migration workflow.

lastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the migration workflow was last modified.

name
Type: string

The name of the migration workflow.

status
Type: string

The status of the migration workflow.

stepTargets
Type: Array of strings

The servers on which a step will be run.

tags
Type: Associative array of custom strings keys (StringMapKey) to strings

The tags added to the migration workflow.

templateId
Type: string

The ID of the template.

workflowInputs
Type: Associative array of custom strings keys (StepInputParametersKey) to StepInput structures

The inputs required to update a migration workflow.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

ResourceNotFoundException:

The resource is not available.

UpdateWorkflowStep 

$result = $client->updateWorkflowStep([/* ... */]);
$promise = $client->updateWorkflowStepAsync([/* ... */]);

Update a step in a migration workflow.

Parameter Syntax

$result = $client->updateWorkflowStep([
    'description' => '<string>',
    'id' => '<string>', // REQUIRED
    'name' => '<string>',
    'next' => ['<string>', ...],
    'outputs' => [
        [
            'dataType' => 'STRING|INTEGER|STRINGLIST|STRINGMAP',
            'name' => '<string>',
            'required' => true || false,
            'value' => [
                'integerValue' => <integer>,
                'listOfStringValue' => ['<string>', ...],
                'stringValue' => '<string>',
            ],
        ],
        // ...
    ],
    'previous' => ['<string>', ...],
    'status' => 'AWAITING_DEPENDENCIES|SKIPPED|READY|IN_PROGRESS|COMPLETED|FAILED|PAUSED|USER_ATTENTION_REQUIRED',
    'stepActionType' => 'MANUAL|AUTOMATED',
    'stepGroupId' => '<string>', // REQUIRED
    'stepTarget' => ['<string>', ...],
    'workflowId' => '<string>', // REQUIRED
    'workflowStepAutomationConfiguration' => [
        'command' => [
            'linux' => '<string>',
            'windows' => '<string>',
        ],
        'runEnvironment' => 'AWS|ONPREMISE',
        'scriptLocationS3Bucket' => '<string>',
        'scriptLocationS3Key' => [
            'linux' => '<string>',
            'windows' => '<string>',
        ],
        'targetType' => 'SINGLE|ALL|NONE',
    ],
]);

Parameter Details

Members
description
Type: string

The description of the step.

id
Required: Yes
Type: string

The ID of the step.

name
Type: string

The name of the step.

next
Type: Array of strings

The next step.

outputs
Type: Array of WorkflowStepOutput structures

The outputs of a step.

previous
Type: Array of strings

The previous step.

status
Type: string

The status of the step.

stepActionType
Type: 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.

stepGroupId
Required: Yes
Type: string

The ID of the step group.

stepTarget
Type: Array of strings

The servers on which a step will be run.

workflowId
Required: Yes
Type: string

The ID of the migration workflow.

workflowStepAutomationConfiguration
Type: WorkflowStepAutomationConfiguration structure

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

Result Syntax

[
    'id' => '<string>',
    'name' => '<string>',
    'stepGroupId' => '<string>',
    'workflowId' => '<string>',
]

Result Details

Members
id
Type: string

The ID of the step.

name
Type: string

The name of the step.

stepGroupId
Type: string

The ID of the step group.

workflowId
Type: string

The ID of the migration workflow.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

UpdateWorkflowStepGroup 

$result = $client->updateWorkflowStepGroup([/* ... */]);
$promise = $client->updateWorkflowStepGroupAsync([/* ... */]);

Update the step group in a migration workflow.

Parameter Syntax

$result = $client->updateWorkflowStepGroup([
    'description' => '<string>',
    'id' => '<string>', // REQUIRED
    'name' => '<string>',
    'next' => ['<string>', ...],
    'previous' => ['<string>', ...],
    'workflowId' => '<string>', // REQUIRED
]);

Parameter Details

Members
description
Type: string

The description of the step group.

id
Required: Yes
Type: string

The ID of the step group.

name
Type: string

The name of the step group.

next
Type: Array of strings

The next step group.

previous
Type: Array of strings

The previous step group.

workflowId
Required: Yes
Type: string

The ID of the migration workflow.

Result Syntax

[
    'description' => '<string>',
    'id' => '<string>',
    'lastModifiedTime' => <DateTime>,
    'name' => '<string>',
    'next' => ['<string>', ...],
    'previous' => ['<string>', ...],
    'tools' => [
        [
            'name' => '<string>',
            'url' => '<string>',
        ],
        // ...
    ],
    'workflowId' => '<string>',
]

Result Details

Members
description
Type: string

The description of the step group.

id
Type: string

The ID of the step group.

lastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the step group was last modified.

name
Type: string

The name of the step group.

next
Type: Array of strings

The next step group.

previous
Type: Array of strings

The previous step group.

tools
Type: Array of Tool structures

List of AWS services utilized in a migration workflow.

workflowId
Type: string

The ID of the migration workflow.

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal error has occurred.

ValidationException:

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

ResourceNotFoundException:

The resource is not available.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members
message
Required: Yes
Type: string

ConflictException

Description

This exception is thrown when an attempt to update or delete a resource would cause an inconsistent state.

Members
message
Required: Yes
Type: string

InternalServerException

Description

An internal error has occurred.

Members
message
Required: Yes
Type: string

MigrationWorkflowSummary

Description

The summary of a migration workflow.

Members
adsApplicationConfigurationName
Type: string

The name of the application configured in Application Discovery Service.

completedSteps
Type: int

The steps completed in the migration workflow.

creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the migration workflow was created.

endTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the migration workflow ended.

id
Type: string

The ID of the migration workflow.

name
Type: string

The name of the migration workflow.

status
Type: string

The status of the migration workflow.

statusMessage
Type: string

The status message of the migration workflow.

templateId
Type: string

The ID of the template.

totalSteps
Type: int

All the steps in a migration workflow.

PlatformCommand

Description

Command to be run on a particular operating system.

Members
linux
Type: string

Command for Linux.

windows
Type: string

Command for Windows.

PlatformScriptKey

Description

The script location for a particular operating system.

Members
linux
Type: string

The script location for Linux.

windows
Type: string

The script location for Windows.

PluginSummary

Description

The summary of the Migration Hub Orchestrator plugin.

Members
hostname
Type: string

The name of the host.

ipAddress
Type: string

The IP address at which the plugin is located.

pluginId
Type: string

The ID of the plugin.

registeredTime
Type: string

The time at which the plugin was registered.

status
Type: string

The status of the plugin.

version
Type: string

The version of the plugin.

ResourceNotFoundException

Description

The resource is not available.

Members
message
Required: Yes
Type: string

StepAutomationConfiguration

Description

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

Members
command
Type: PlatformCommand structure

The command to run the script.

runEnvironment
Type: string

The source or target environment.

scriptLocationS3Bucket
Type: string

The Amazon S3 bucket where the script is located.

scriptLocationS3Key
Type: PlatformScriptKey structure

The Amazon S3 key for the script location.

targetType
Type: string

The servers on which to run the script.

StepInput

Description

A map of key value pairs that is generated when you create a migration workflow. The key value pairs will differ based on your selection of the template.

Members
integerValue
Type: int

The value of the integer.

listOfStringsValue
Type: Array of strings

List of string values.

mapOfStringValue
Type: Associative array of custom strings keys (StringMapKey) to strings

Map of string values.

stringValue
Type: string

String value.

StepOutput

Description

The output of the step.

Members
dataType
Type: string

The data type of the step output.

name
Type: string

The name of the step.

required
Type: boolean

Determine if an output is required from a step.

TemplateInput

Description

The input parameters of a template.

Members
dataType
Type: string

The data type of the template input.

inputName
Type: string

The name of the template.

required
Type: boolean

Determine if an input is required from the template.

TemplateSource

Description

The migration workflow template used as the source for the new template.

Members
workflowId
Type: string

The ID of the workflow from the source migration workflow template.

TemplateStepGroupSummary

Description

The summary of the step group in the template.

Members
id
Type: string

The ID of the step group.

name
Type: string

The name of the step group.

next
Type: Array of strings

The next step group.

previous
Type: Array of strings

The previous step group.

TemplateStepSummary

Description

The summary of the step.

Members
id
Type: string

The ID of the step.

name
Type: string

The name of the step.

next
Type: Array of strings

The next step.

owner
Type: string

The owner of the step.

previous
Type: Array of strings

The previous step.

stepActionType
Type: 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.

stepGroupId
Type: string

The ID of the step group.

targetType
Type: string

The servers on which to run the script.

templateId
Type: string

The ID of the template.

TemplateSummary

Description

The summary of the template.

Members
arn
Type: string

The Amazon Resource Name (ARN) of the template.

description
Type: string

The description of the template.

id
Type: string

The ID of the template.

name
Type: string

The name of the template.

ThrottlingException

Description

The request was denied due to request throttling.

Members
message
Required: Yes
Type: string

Tool

Description

List of AWS services utilized in a migration workflow.

Members
name
Type: string

The name of an AWS service.

url
Type: string

The URL of an AWS service.

ValidationException

Description

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

Members
message
Required: Yes
Type: string

WorkflowStepAutomationConfiguration

Description

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

Members
command
Type: PlatformCommand structure

The command required to run the script.

runEnvironment
Type: string

The source or target environment.

scriptLocationS3Bucket
Type: string

The Amazon S3 bucket where the script is located.

scriptLocationS3Key
Type: PlatformScriptKey structure

The Amazon S3 key for the script location.

targetType
Type: string

The servers on which to run the script.

WorkflowStepGroupSummary

Description

The summary of a step group in a workflow.

Members
id
Type: string

The ID of the step group.

name
Type: string

The name of the step group.

next
Type: Array of strings

The next step group.

owner
Type: string

The owner of the step group.

previous
Type: Array of strings

The previous step group.

status
Type: string

The status of the step group.

WorkflowStepOutput

Description

The output of a step.

Members
dataType
Type: string

The data type of the output.

name
Type: string

The name of the step.

required
Type: boolean

Determine if an output is required from a step.

value
Type: WorkflowStepOutputUnion structure

The value of the output.

WorkflowStepOutputUnion

Description

A structure to hold multiple values of an output.

Members
integerValue
Type: int

The integer value.

listOfStringValue
Type: Array of strings

The list of string value.

stringValue
Type: string

The string value.

WorkflowStepSummary

Description

The summary of the step in a migration workflow.

Members
description
Type: string

The description of the step.

name
Type: string

The name of the step.

next
Type: Array of strings

The next step.

noOfSrvCompleted
Type: int

The number of servers that have been migrated.

noOfSrvFailed
Type: int

The number of servers that have failed to migrate.

owner
Type: string

The owner of the step.

previous
Type: Array of strings

The previous step.

scriptLocation
Type: string

The location of the script.

status
Type: string

The status of the step.

statusMessage
Type: string

The status message of the migration workflow.

stepActionType
Type: 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.

stepId
Type: string

The ID of the step.

totalNoOfSrv
Type: int

The total number of servers that have been migrated.