UpdateWorkflow - Migration Hub Orchestrator

UpdateWorkflow

Update a migration workflow.

Request Syntax

POST /migrationworkflow/id HTTP/1.1 Content-type: application/json { "description": "string", "inputParameters": { "string" : { ... } }, "name": "string", "stepTargets": [ "string" ] }

URI Request Parameters

The request uses the following URI parameters.

id

The ID of the migration workflow.

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

description

The description of the migration workflow.

Type: String

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

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

Required: No

inputParameters

The input parameters required to update a migration workflow.

Type: String to StepInput object map

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

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

Required: No

name

The name of the migration workflow.

Type: String

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

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

Required: No

stepTargets

The servers on which a step will be run.

Type: Array of strings

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

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "adsApplicationConfigurationId": "string", "arn": "string", "creationTime": number, "description": "string", "id": "string", "lastModifiedTime": number, "name": "string", "status": "string", "stepTargets": [ "string" ], "tags": { "string" : "string" }, "templateId": "string", "workflowInputs": { "string" : { ... } } }

Response Elements

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

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

adsApplicationConfigurationId

The ID of the application configured in Application Discovery Service.

Type: String

arn

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

Type: String

creationTime

The time at which the migration workflow was created.

Type: Timestamp

description

The description of the migration workflow.

Type: String

id

The ID of the migration workflow.

Type: String

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

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

lastModifiedTime

The time at which the migration workflow was last modified.

Type: Timestamp

name

The name of the migration workflow.

Type: String

status

The status of the migration workflow.

Type: String

Valid Values: CREATING | NOT_STARTED | CREATION_FAILED | STARTING | IN_PROGRESS | WORKFLOW_FAILED | PAUSED | PAUSING | PAUSING_FAILED | USER_ATTENTION_REQUIRED | DELETING | DELETION_FAILED | DELETED | COMPLETED

stepTargets

The servers on which a step will be run.

Type: Array of strings

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

tags

The tags added to the migration workflow.

Type: String to string map

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

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

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

templateId

The ID of the template.

Type: String

workflowInputs

The inputs required to update a migration workflow.

Type: String to StepInput object map

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

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

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An internal error has occurred.

HTTP Status Code: 500

ResourceNotFoundException

The resource is not available.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400

See Also

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