"documentation":"

Delete a step group in a migration workflow.

", "idempotent":true }, "GetTemplate":{ "name":"GetTemplate", "http":{ "method":"GET", "requestUri":"/migrationworkflowtemplate/{id}", "responseCode":200 }, "input":{"shape":"GetMigrationWorkflowTemplateRequest"}, "output":{"shape":"GetMigrationWorkflowTemplateResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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

" }, "GetTemplateStep":{ "name":"GetTemplateStep", "http":{ "method":"GET", "requestUri":"/templatestep/{id}", "responseCode":200 }, "input":{"shape":"GetTemplateStepRequest"}, "output":{"shape":"GetTemplateStepResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Get a specific step in a template.

" }, "GetTemplateStepGroup":{ "name":"GetTemplateStepGroup", "http":{ "method":"GET", "requestUri":"/templates/{templateId}/stepgroups/{id}", "responseCode":200 }, "input":{"shape":"GetTemplateStepGroupRequest"}, "output":{"shape":"GetTemplateStepGroupResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Get a step group in a template.

" }, "GetWorkflow":{ "name":"GetWorkflow", "http":{ "method":"GET", "requestUri":"/migrationworkflow/{id}", "responseCode":200 }, "input":{"shape":"GetMigrationWorkflowRequest"}, "output":{"shape":"GetMigrationWorkflowResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Get migration workflow.

" }, "GetWorkflowStep":{ "name":"GetWorkflowStep", "http":{ "method":"GET", "requestUri":"/workflowstep/{id}", "responseCode":200 }, "input":{"shape":"GetWorkflowStepRequest"}, "output":{"shape":"GetWorkflowStepResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Get a step in the migration workflow.

" }, "GetWorkflowStepGroup":{ "name":"GetWorkflowStepGroup", "http":{ "method":"GET", "requestUri":"/workflowstepgroup/{id}", "responseCode":200 }, "input":{"shape":"GetWorkflowStepGroupRequest"}, "output":{"shape":"GetWorkflowStepGroupResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Get the step group of a migration workflow.

" }, "ListPlugins":{ "name":"ListPlugins", "http":{ "method":"GET", "requestUri":"/plugins", "responseCode":200 }, "input":{"shape":"ListPluginsRequest"}, "output":{"shape":"ListPluginsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

List AWS Migration Hub Orchestrator plugins.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

List the tags added to a resource.

" }, "ListTemplateStepGroups":{ "name":"ListTemplateStepGroups", "http":{ "method":"GET", "requestUri":"/templatestepgroups/{templateId}", "responseCode":200 }, "input":{"shape":"ListTemplateStepGroupsRequest"}, "output":{"shape":"ListTemplateStepGroupsResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

List the step groups in a template.

" }, "ListTemplateSteps":{ "name":"ListTemplateSteps", "http":{ "method":"GET", "requestUri":"/templatesteps", "responseCode":200 }, "input":{"shape":"ListTemplateStepsRequest"}, "output":{"shape":"ListTemplateStepsResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

List the steps in a template.

" }, "ListTemplates":{ "name":"ListTemplates", "http":{ "method":"GET", "requestUri":"/migrationworkflowtemplates", "responseCode":200 }, "input":{"shape":"ListMigrationWorkflowTemplatesRequest"}, "output":{"shape":"ListMigrationWorkflowTemplatesResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

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

" }, "ListWorkflowStepGroups":{ "name":"ListWorkflowStepGroups", "http":{ "method":"GET", "requestUri":"/workflowstepgroups", "responseCode":200 }, "input":{"shape":"ListWorkflowStepGroupsRequest"}, "output":{"shape":"ListWorkflowStepGroupsResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

List the step groups in a migration workflow.

" }, "ListWorkflowSteps":{ "name":"ListWorkflowSteps", "http":{ "method":"GET", "requestUri":"/workflow/{workflowId}/workflowstepgroups/{stepGroupId}/workflowsteps", "responseCode":200 }, "input":{"shape":"ListWorkflowStepsRequest"}, "output":{"shape":"ListWorkflowStepsResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

List the steps in a workflow.

" }, "ListWorkflows":{ "name":"ListWorkflows", "http":{ "method":"GET", "requestUri":"/migrationworkflows", "responseCode":200 }, "input":{"shape":"ListMigrationWorkflowsRequest"}, "output":{"shape":"ListMigrationWorkflowsResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

List the migration workflows.

" }, "RetryWorkflowStep":{ "name":"RetryWorkflowStep", "http":{ "method":"POST", "requestUri":"/retryworkflowstep/{id}", "responseCode":200 }, "input":{"shape":"RetryWorkflowStepRequest"}, "output":{"shape":"RetryWorkflowStepResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Retry a failed step in a migration workflow.

" }, "StartWorkflow":{ "name":"StartWorkflow", "http":{ "method":"POST", "requestUri":"/migrationworkflow/{id}/start", "responseCode":200 }, "input":{"shape":"StartMigrationWorkflowRequest"}, "output":{"shape":"StartMigrationWorkflowResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Start a migration workflow.

" }, "StopWorkflow":{ "name":"StopWorkflow", "http":{ "method":"POST", "requestUri":"/migrationworkflow/{id}/stop", "responseCode":200 }, "input":{"shape":"StopMigrationWorkflowRequest"}, "output":{"shape":"StopMigrationWorkflowResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Stop an ongoing migration workflow.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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

", "idempotent":true }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes the tags for a resource.

", "idempotent":true }, "UpdateWorkflow":{ "name":"UpdateWorkflow", "http":{ "method":"POST", "requestUri":"/migrationworkflow/{id}", "responseCode":200 }, "input":{"shape":"UpdateMigrationWorkflowRequest"}, "output":{"shape":"UpdateMigrationWorkflowResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Update a migration workflow.

" }, "UpdateWorkflowStep":{ "name":"UpdateWorkflowStep", "http":{ "method":"POST", "requestUri":"/workflowstep/{id}", "responseCode":200 }, "input":{"shape":"UpdateWorkflowStepRequest"}, "output":{"shape":"UpdateWorkflowStepResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Update a step in a migration workflow.

" }, "UpdateWorkflowStepGroup":{ "name":"UpdateWorkflowStepGroup", "http":{ "method":"POST", "requestUri":"/workflowstepgroup/{id}", "responseCode":202 }, "input":{"shape":"UpdateWorkflowStepGroupRequest"}, "output":{"shape":"UpdateWorkflowStepGroupResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Update the step group in a migration workflow.

", "idempotent":true } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

You do not have sufficient access to perform this action.

", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true, "retryable":{"throttling":false} }, "ApplicationConfigurationName":{ "type":"string", "max":100, "min":1, "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" }, "Boolean":{ "type":"boolean", "box":true }, "CreateMigrationWorkflowRequest":{ "type":"structure", "required":[ "name", "templateId", "applicationConfigurationId", "inputParameters" ], "members":{ "name":{ "shape":"CreateMigrationWorkflowRequestNameString", "documentation":"

The name of the migration workflow.

" }, "description":{ "shape":"CreateMigrationWorkflowRequestDescriptionString", "documentation":"

The description of the migration workflow.

" }, "templateId":{ "shape":"CreateMigrationWorkflowRequestTemplateIdString", "documentation":"

The ID of the template.

" }, "applicationConfigurationId":{ "shape":"CreateMigrationWorkflowRequestApplicationConfigurationIdString", "documentation":"

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

" }, "inputParameters":{ "shape":"StepInputParameters", "documentation":"

The input parameters required to create a migration workflow.

" }, "stepTargets":{ "shape":"StringList", "documentation":"

The servers on which a step will be run.

" }, "tags":{ "shape":"StringMap", "documentation":"

The tags to add on a migration workflow.

" } } }, "CreateMigrationWorkflowRequestApplicationConfigurationIdString":{ "type":"string", "max":100, "min":1, "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" }, "CreateMigrationWorkflowRequestDescriptionString":{ "type":"string", "max":500, "min":0, "pattern":"[-a-zA-Z0-9_.+, ]*" }, "CreateMigrationWorkflowRequestNameString":{ "type":"string", "max":100, "min":1, "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" }, "CreateMigrationWorkflowRequestTemplateIdString":{ "type":"string", "max":100, "min":1, "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" }, "CreateMigrationWorkflowResponse":{ "type":"structure", "members":{ "id":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

" }, "arn":{ "shape":"String", "documentation":"

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

" }, "name":{ "shape":"String", "documentation":"

The name of the migration workflow.

" }, "description":{ "shape":"String", "documentation":"

The description of the migration workflow.

" }, "templateId":{ "shape":"String", "documentation":"

The ID of the template.

" }, "adsApplicationConfigurationId":{ "shape":"String", "documentation":"

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

" }, "workflowInputs":{ "shape":"StepInputParameters", "documentation":"

The inputs for creating a migration workflow.

" }, "stepTargets":{ "shape":"StringList", "documentation":"

The servers on which a step will be run.

" }, "status":{ "shape":"MigrationWorkflowStatusEnum", "documentation":"

The status of the migration workflow.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

The time at which the migration workflow was created.

" }, "tags":{ "shape":"StringMap", "documentation":"

The tags to add on a migration workflow.

" } } }, "CreateWorkflowStepGroupRequest":{ "type":"structure", "required":[ "workflowId", "name" ], "members":{ "workflowId":{ "shape":"MigrationWorkflowId", "documentation":"

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

" }, "name":{ "shape":"StepGroupName", "documentation":"

The name of the step group.

" }, "description":{ "shape":"StepGroupDescription", "documentation":"

The description of the step group.

" }, "next":{ "shape":"StringList", "documentation":"

The next step group.

" }, "previous":{ "shape":"StringList", "documentation":"

The previous step group.

" } } }, "CreateWorkflowStepGroupResponse":{ "type":"structure", "members":{ "workflowId":{ "shape":"String", "documentation":"

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

" }, "name":{ "shape":"String", "documentation":"

The name of the step group.

" }, "id":{ "shape":"String", "documentation":"

The ID of the step group.

" }, "description":{ "shape":"String", "documentation":"

The description of the step group.

" }, "tools":{ "shape":"ToolsList", "documentation":"

List of AWS services utilized in a migration workflow.

" }, "next":{ "shape":"StringList", "documentation":"

The next step group.

" }, "previous":{ "shape":"StringList", "documentation":"

The previous step group.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

The time at which the step group is created.

" } } }, "CreateWorkflowStepRequest":{ "type":"structure", "required":[ "name", "stepGroupId", "workflowId", "stepActionType" ], "members":{ "name":{ "shape":"MigrationWorkflowName", "documentation":"

The name of the step.

" }, "stepGroupId":{ "shape":"StepGroupId", "documentation":"

The ID of the step group.

" }, "workflowId":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

" }, "stepActionType":{ "shape":"StepActionType", "documentation":"

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.

" }, "description":{ "shape":"MigrationWorkflowDescription", "documentation":"

The description of the step.

" }, "workflowStepAutomationConfiguration":{ "shape":"WorkflowStepAutomationConfiguration", "documentation":"

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

" }, "stepTarget":{ "shape":"StringList", "documentation":"

The servers on which a step will be run.

" }, "outputs":{ "shape":"WorkflowStepOutputList", "documentation":"

The key value pairs added for the expected output.

" }, "previous":{ "shape":"StringList", "documentation":"

The previous step.

" }, "next":{ "shape":"StringList", "documentation":"

The next step.

" } } }, "CreateWorkflowStepResponse":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The ID of the step.

" }, "stepGroupId":{ "shape":"String", "documentation":"

The ID of the step group.

" }, "workflowId":{ "shape":"String", "documentation":"

The ID of the migration workflow.

" }, "name":{ "shape":"String", "documentation":"

The name of the step.

" } } }, "DataType":{ "type":"string", "enum":[ "STRING", "INTEGER", "STRINGLIST", "STRINGMAP" ] }, "DeleteMigrationWorkflowRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow you want to delete.

", "location":"uri", "locationName":"id" } } }, "DeleteMigrationWorkflowResponse":{ "type":"structure", "members":{ "id":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

" }, "arn":{ "shape":"String", "documentation":"

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

" }, "status":{ "shape":"MigrationWorkflowStatusEnum", "documentation":"

The status of the migration workflow.

" } } }, "DeleteWorkflowStepGroupRequest":{ "type":"structure", "required":[ "workflowId", "id" ], "members":{ "workflowId":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

", "location":"querystring", "locationName":"workflowId" }, "id":{ "shape":"StepGroupId", "documentation":"

The ID of the step group you want to delete.

", "location":"uri", "locationName":"id" } } }, "DeleteWorkflowStepGroupResponse":{ "type":"structure", "members":{ } }, "DeleteWorkflowStepRequest":{ "type":"structure", "required":[ "id", "stepGroupId", "workflowId" ], "members":{ "id":{ "shape":"StepId", "documentation":"

The ID of the step you want to delete.

", "location":"uri", "locationName":"id" }, "stepGroupId":{ "shape":"StepGroupId", "documentation":"

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

", "location":"querystring", "locationName":"stepGroupId" }, "workflowId":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

", "location":"querystring", "locationName":"workflowId" } } }, "DeleteWorkflowStepResponse":{ "type":"structure", "members":{ } }, "GetMigrationWorkflowRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

", "location":"uri", "locationName":"id" } } }, "GetMigrationWorkflowResponse":{ "type":"structure", "members":{ "id":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

" }, "arn":{ "shape":"String", "documentation":"

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

" }, "name":{ "shape":"String", "documentation":"

The name of the migration workflow.

" }, "description":{ "shape":"String", "documentation":"

The description of the migration workflow.

" }, "templateId":{ "shape":"String", "documentation":"

The ID of the template.

" }, "adsApplicationConfigurationId":{ "shape":"String", "documentation":"

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

" }, "adsApplicationName":{ "shape":"String", "documentation":"

The name of the application configured in Application Discovery Service.

" }, "status":{ "shape":"MigrationWorkflowStatusEnum", "documentation":"

The status of the migration workflow.

" }, "statusMessage":{ "shape":"String", "documentation":"

The status message of the migration workflow.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

The time at which the migration workflow was created.

" }, "lastStartTime":{ "shape":"Timestamp", "documentation":"

The time at which the migration workflow was last started.

" }, "lastStopTime":{ "shape":"Timestamp", "documentation":"

The time at which the migration workflow was last stopped.

" }, "lastModifiedTime":{ "shape":"Timestamp", "documentation":"

The time at which the migration workflow was last modified.

" }, "endTime":{ "shape":"Timestamp", "documentation":"

The time at which the migration workflow ended.

" }, "tools":{ "shape":"ToolsList", "documentation":"

List of AWS services utilized in a migration workflow.

" }, "totalSteps":{ "shape":"Integer", "documentation":"

The total number of steps in the migration workflow.

" }, "completedSteps":{ "shape":"Integer", "documentation":"

Get a list of completed steps in the migration workflow.

" }, "workflowInputs":{ "shape":"StepInputParameters", "documentation":"

The inputs required for creating the migration workflow.

" }, "tags":{ "shape":"StringMap", "documentation":"

The tags added to the migration workflow.

" }, "workflowBucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket where the migration logs are stored.

" } } }, "GetMigrationWorkflowTemplateRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"TemplateId", "documentation":"

The ID of the template.

", "location":"uri", "locationName":"id" } } }, "GetMigrationWorkflowTemplateResponse":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The ID of the template.

" }, "name":{ "shape":"String", "documentation":"

The name of the template.

" }, "description":{ "shape":"String", "documentation":"

The time at which the template was last created.

" }, "inputs":{ "shape":"TemplateInputList", "documentation":"

The inputs provided for the creation of the migration workflow.

" }, "tools":{ "shape":"ToolsList", "documentation":"

List of AWS services utilized in a migration workflow.

" }, "status":{ "shape":"TemplateStatus", "documentation":"

The status of the template.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

The time at which the template was last created.

" } } }, "GetTemplateStepGroupRequest":{ "type":"structure", "required":[ "templateId", "id" ], "members":{ "templateId":{ "shape":"TemplateId", "documentation":"

The ID of the template.

", "location":"uri", "locationName":"templateId" }, "id":{ "shape":"StepGroupId", "documentation":"

The ID of the step group.

", "location":"uri", "locationName":"id" } } }, "GetTemplateStepGroupResponse":{ "type":"structure", "members":{ "templateId":{ "shape":"String", "documentation":"

The ID of the template.

" }, "id":{ "shape":"String", "documentation":"

The ID of the step group.

" }, "name":{ "shape":"String", "documentation":"

The name of the step group.

" }, "description":{ "shape":"String", "documentation":"

The description of the step group.

" }, "status":{ "shape":"StepGroupStatus", "documentation":"

The status of the step group.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

The time at which the step group was created.

" }, "lastModifiedTime":{ "shape":"Timestamp", "documentation":"

The time at which the step group was last modified.

" }, "tools":{ "shape":"ToolsList", "documentation":"

List of AWS services utilized in a migration workflow.

" }, "previous":{ "shape":"StringList", "documentation":"

The previous step group.

" }, "next":{ "shape":"StringList", "documentation":"

The next step group.

" } } }, "GetTemplateStepRequest":{ "type":"structure", "required":[ "id", "templateId", "stepGroupId" ], "members":{ "id":{ "shape":"StepId", "documentation":"

The ID of the step.

", "location":"uri", "locationName":"id" }, "templateId":{ "shape":"TemplateId", "documentation":"

The ID of the template.

", "location":"querystring", "locationName":"templateId" }, "stepGroupId":{ "shape":"StepGroupId", "documentation":"

The ID of the step group.

", "location":"querystring", "locationName":"stepGroupId" } } }, "GetTemplateStepResponse":{ "type":"structure", "members":{ "id":{ "shape":"StepId", "documentation":"

The ID of the step.

" }, "stepGroupId":{ "shape":"StepGroupId", "documentation":"

The ID of the step group.

" }, "templateId":{ "shape":"TemplateId", "documentation":"

The ID of the template.

" }, "name":{ "shape":"String", "documentation":"

The name of the step.

" }, "description":{ "shape":"String", "documentation":"

The description of the step.

" }, "stepActionType":{ "shape":"StepActionType", "documentation":"

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.

" }, "creationTime":{ "shape":"String", "documentation":"

The time at which the step was created.

" }, "previous":{ "shape":"StringList", "documentation":"

The previous step.

" }, "next":{ "shape":"StringList", "documentation":"

The next step.

" }, "outputs":{ "shape":"StepOutputList", "documentation":"

The outputs of the step.

" }, "stepAutomationConfiguration":{ "shape":"StepAutomationConfiguration", "documentation":"

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

" } } }, "GetWorkflowStepGroupRequest":{ "type":"structure", "required":[ "id", "workflowId" ], "members":{ "id":{ "shape":"StepGroupId", "documentation":"

The ID of the step group.

", "location":"uri", "locationName":"id" }, "workflowId":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

", "location":"querystring", "locationName":"workflowId" } } }, "GetWorkflowStepGroupResponse":{ "type":"structure", "members":{ "id":{ "shape":"StepGroupId", "documentation":"

The ID of the step group.

" }, "workflowId":{ "shape":"String", "documentation":"

The ID of the migration workflow.

" }, "name":{ "shape":"String", "documentation":"

The name of the step group.

" }, "description":{ "shape":"String", "documentation":"

The description of the step group.

" }, "status":{ "shape":"StepGroupStatus", "documentation":"

The status of the step group.

" }, "owner":{ "shape":"Owner", "documentation":"

The owner of the step group.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

The time at which the step group was created.

" }, "lastModifiedTime":{ "shape":"Timestamp", "documentation":"

The time at which the step group was last modified.

" }, "endTime":{ "shape":"Timestamp", "documentation":"

The time at which the step group ended.

" }, "tools":{ "shape":"ToolsList", "documentation":"

List of AWS services utilized in a migration workflow.

" }, "previous":{ "shape":"StringList", "documentation":"

The previous step group.

" }, "next":{ "shape":"StringList", "documentation":"

The next step group.

" } } }, "GetWorkflowStepRequest":{ "type":"structure", "required":[ "workflowId", "stepGroupId", "id" ], "members":{ "workflowId":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

", "location":"querystring", "locationName":"workflowId" }, "stepGroupId":{ "shape":"StepGroupId", "documentation":"

desThe ID of the step group.

", "location":"querystring", "locationName":"stepGroupId" }, "id":{ "shape":"StepId", "documentation":"

The ID of the step.

", "location":"uri", "locationName":"id" } } }, "GetWorkflowStepResponse":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the step.

" }, "stepGroupId":{ "shape":"String", "documentation":"

The ID of the step group.

" }, "workflowId":{ "shape":"String", "documentation":"

The ID of the migration workflow.

" }, "stepId":{ "shape":"String", "documentation":"

The ID of the step.

" }, "description":{ "shape":"String", "documentation":"

The description of the step.

" }, "stepActionType":{ "shape":"StepActionType", "documentation":"

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.

" }, "owner":{ "shape":"Owner", "documentation":"

The owner of the step.

" }, "workflowStepAutomationConfiguration":{ "shape":"WorkflowStepAutomationConfiguration", "documentation":"

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

" }, "stepTarget":{ "shape":"StringList", "documentation":"

The servers on which a step will be run.

" }, "outputs":{ "shape":"GetWorkflowStepResponseOutputsList", "documentation":"

The outputs of the step.

" }, "previous":{ "shape":"StringList", "documentation":"

The previous step.

" }, "next":{ "shape":"StringList", "documentation":"

The next step.

" }, "status":{ "shape":"StepStatus", "documentation":"

The status of the step.

" }, "statusMessage":{ "shape":"String", "documentation":"

The status message of the migration workflow.

" }, "scriptOutputLocation":{ "shape":"String", "documentation":"

The output location of the script.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

The time at which the step was created.

" }, "lastStartTime":{ "shape":"Timestamp", "documentation":"

The time at which the workflow was last started.

" }, "endTime":{ "shape":"Timestamp", "documentation":"

The time at which the step ended.

" }, "noOfSrvCompleted":{ "shape":"Integer", "documentation":"

The number of servers that have been migrated.

" }, "noOfSrvFailed":{ "shape":"Integer", "documentation":"

The number of servers that have failed to migrate.

" }, "totalNoOfSrv":{ "shape":"Integer", "documentation":"

The total number of servers that have been migrated.

" } } }, "GetWorkflowStepResponseOutputsList":{ "type":"list", "member":{"shape":"WorkflowStepOutput"}, "max":5, "min":0 }, "IPAddress":{ "type":"string", "max":15, "min":0, "pattern":"(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])" }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

An internal error has occurred.

", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "ListMigrationWorkflowTemplatesRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results that can be returned.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

", "location":"querystring", "locationName":"nextToken" }, "name":{ "shape":"TemplateName", "documentation":"

The name of the template.

", "location":"querystring", "locationName":"name" } } }, "ListMigrationWorkflowTemplatesResponse":{ "type":"structure", "required":["templateSummary"], "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "templateSummary":{ "shape":"TemplateSummaryList", "documentation":"

The summary of the template.

" } } }, "ListMigrationWorkflowsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results that can be returned.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

", "location":"querystring", "locationName":"nextToken" }, "templateId":{ "shape":"TemplateId", "documentation":"

The ID of the template.

", "location":"querystring", "locationName":"templateId" }, "adsApplicationConfigurationName":{ "shape":"ApplicationConfigurationName", "documentation":"

The name of the application configured in Application Discovery Service.

", "location":"querystring", "locationName":"adsApplicationConfigurationName" }, "status":{ "shape":"MigrationWorkflowStatusEnum", "documentation":"

The status of the migration workflow.

", "location":"querystring", "locationName":"status" }, "name":{ "shape":"String", "documentation":"

The name of the migration workflow.

", "location":"querystring", "locationName":"name" } } }, "ListMigrationWorkflowsResponse":{ "type":"structure", "required":["migrationWorkflowSummary"], "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "migrationWorkflowSummary":{ "shape":"MigrationWorkflowSummaryList", "documentation":"

The summary of the migration workflow.

" } } }, "ListPluginsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of plugins that can be returned.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

", "location":"querystring", "locationName":"nextToken" } } }, "ListPluginsResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "plugins":{ "shape":"PluginSummaries", "documentation":"

Migration Hub Orchestrator plugins.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"ResourceArn", "documentation":"

The Amazon Resource Name (ARN) of the resource.

", "location":"uri", "locationName":"resourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"TagMap", "documentation":"

The tags added to a resource.

" } } }, "ListTemplateStepGroupsRequest":{ "type":"structure", "required":["templateId"], "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results that can be returned.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

", "location":"querystring", "locationName":"nextToken" }, "templateId":{ "shape":"TemplateId", "documentation":"

The ID of the template.

", "location":"uri", "locationName":"templateId" } } }, "ListTemplateStepGroupsResponse":{ "type":"structure", "required":["templateStepGroupSummary"], "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "templateStepGroupSummary":{ "shape":"TemplateStepGroupSummaryList", "documentation":"

The summary of the step group in the template.

" } } }, "ListTemplateStepsRequest":{ "type":"structure", "required":[ "templateId", "stepGroupId" ], "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results that can be returned.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

", "location":"querystring", "locationName":"nextToken" }, "templateId":{ "shape":"TemplateId", "documentation":"

The ID of the template.

", "location":"querystring", "locationName":"templateId" }, "stepGroupId":{ "shape":"StepGroupId", "documentation":"

The ID of the step group.

", "location":"querystring", "locationName":"stepGroupId" } } }, "ListTemplateStepsResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "templateStepSummaryList":{ "shape":"TemplateStepSummaryList", "documentation":"

The list of summaries of steps in a template.

" } } }, "ListWorkflowStepGroupsRequest":{ "type":"structure", "required":["workflowId"], "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results that can be returned.

", "location":"querystring", "locationName":"maxResults" }, "workflowId":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

", "location":"querystring", "locationName":"workflowId" } } }, "ListWorkflowStepGroupsResponse":{ "type":"structure", "required":["workflowStepGroupsSummary"], "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "workflowStepGroupsSummary":{ "shape":"WorkflowStepGroupsSummaryList", "documentation":"

The summary of step groups in a migration workflow.

" } } }, "ListWorkflowStepsRequest":{ "type":"structure", "required":[ "workflowId", "stepGroupId" ], "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results that can be returned.

", "location":"querystring", "locationName":"maxResults" }, "workflowId":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

", "location":"uri", "locationName":"workflowId" }, "stepGroupId":{ "shape":"StepGroupId", "documentation":"

The ID of the step group.

", "location":"uri", "locationName":"stepGroupId" } } }, "ListWorkflowStepsResponse":{ "type":"structure", "required":["workflowStepsSummary"], "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "workflowStepsSummary":{ "shape":"WorkflowStepsSummaryList", "documentation":"

The summary of steps in a migration workflow.

" } } }, "MaxResults":{ "type":"integer", "max":100, "min":0 }, "MigrationWorkflowDescription":{ "type":"string", "max":500, "min":0, "pattern":"[-a-zA-Z0-9_.+, ]*" }, "MigrationWorkflowId":{ "type":"string", "max":100, "min":1, "pattern":"[a-zA-Z0-9-]+" }, "MigrationWorkflowName":{ "type":"string", "max":100, "min":1, "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" }, "MigrationWorkflowStatusEnum":{ "type":"string", "enum":[ "CREATING", "NOT_STARTED", "CREATION_FAILED", "STARTING", "IN_PROGRESS", "WORKFLOW_FAILED", "PAUSED", "PAUSING", "PAUSING_FAILED", "USER_ATTENTION_REQUIRED", "DELETING", "DELETION_FAILED", "DELETED", "COMPLETED" ] }, "MigrationWorkflowSummary":{ "type":"structure", "members":{ "id":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

" }, "name":{ "shape":"String", "documentation":"

The name of the migration workflow.

" }, "templateId":{ "shape":"String", "documentation":"

The ID of the template.

" }, "adsApplicationConfigurationName":{ "shape":"String", "documentation":"

The name of the application configured in Application Discovery Service.

" }, "status":{ "shape":"MigrationWorkflowStatusEnum", "documentation":"

The status of the migration workflow.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

The time at which the migration workflow was created.

" }, "endTime":{ "shape":"Timestamp", "documentation":"

The time at which the migration workflow ended.

" }, "statusMessage":{ "shape":"String", "documentation":"

The status message of the migration workflow.

" }, "completedSteps":{ "shape":"Integer", "documentation":"

The steps completed in the migration workflow.

" }, "totalSteps":{ "shape":"Integer", "documentation":"

All the steps in a migration workflow.

" } }, "documentation":"

The summary of a migration workflow.

" }, "MigrationWorkflowSummaryList":{ "type":"list", "member":{"shape":"MigrationWorkflowSummary"} }, "NextToken":{ "type":"string", "max":2048, "min":0, "pattern":".*\\S.*" }, "Owner":{ "type":"string", "enum":[ "AWS_MANAGED", "CUSTOM" ] }, "PlatformCommand":{ "type":"structure", "members":{ "linux":{ "shape":"String", "documentation":"

Command for Linux.

" }, "windows":{ "shape":"String", "documentation":"

Command for Windows.

" } }, "documentation":"

Command to be run on a particular operating system.

" }, "PlatformScriptKey":{ "type":"structure", "members":{ "linux":{ "shape":"S3Key", "documentation":"

The script location for Linux.

" }, "windows":{ "shape":"S3Key", "documentation":"

The script location for Windows.

" } }, "documentation":"

The script location for a particular operating system.

" }, "PluginHealth":{ "type":"string", "enum":[ "HEALTHY", "UNHEALTHY" ] }, "PluginId":{ "type":"string", "max":60, "min":1, "pattern":".*\\S.*" }, "PluginSummaries":{ "type":"list", "member":{"shape":"PluginSummary"} }, "PluginSummary":{ "type":"structure", "members":{ "pluginId":{ "shape":"PluginId", "documentation":"

The ID of the plugin.

" }, "hostname":{ "shape":"String", "documentation":"

The name of the host.

" }, "status":{ "shape":"PluginHealth", "documentation":"

The status of the plugin.

" }, "ipAddress":{ "shape":"IPAddress", "documentation":"

The IP address at which the plugin is located.

" }, "version":{ "shape":"PluginVersion", "documentation":"

The version of the plugin.

" }, "registeredTime":{ "shape":"String", "documentation":"

The time at which the plugin was registered.

" } }, "documentation":"

The summary of the Migration Hub Orchestrator plugin.

" }, "PluginVersion":{ "type":"string", "max":1024, "min":0, "pattern":".*" }, "ResourceArn":{ "type":"string", "pattern":"arn:aws:migrationhub-orchestrator:[a-z0-9-]+:[0-9]+:workflow/[.]*" }, "ResourceNotFoundException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The resource is not available.

", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "RetryWorkflowStepRequest":{ "type":"structure", "required":[ "workflowId", "stepGroupId", "id" ], "members":{ "workflowId":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

", "location":"querystring", "locationName":"workflowId" }, "stepGroupId":{ "shape":"StepGroupId", "documentation":"

The ID of the step group.

", "location":"querystring", "locationName":"stepGroupId" }, "id":{ "shape":"StepId", "documentation":"

The ID of the step.

", "location":"uri", "locationName":"id" } } }, "RetryWorkflowStepResponse":{ "type":"structure", "members":{ "stepGroupId":{ "shape":"String", "documentation":"

The ID of the step group.

" }, "workflowId":{ "shape":"String", "documentation":"

The ID of the migration workflow.

" }, "id":{ "shape":"String", "documentation":"

The ID of the step.

" }, "status":{ "shape":"StepStatus", "documentation":"

The status of the step.

" } } }, "RunEnvironment":{ "type":"string", "enum":[ "AWS", "ONPREMISE" ] }, "S3Bucket":{ "type":"string", "max":63, "min":0, "pattern":"[0-9a-z]+[0-9a-z\\.\\-]*[0-9a-z]+" }, "S3Key":{ "type":"string", "max":1024, "min":0 }, "StartMigrationWorkflowRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

", "location":"uri", "locationName":"id" } } }, "StartMigrationWorkflowResponse":{ "type":"structure", "members":{ "id":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

" }, "arn":{ "shape":"String", "documentation":"

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

" }, "status":{ "shape":"MigrationWorkflowStatusEnum", "documentation":"

The status of the migration workflow.

" }, "statusMessage":{ "shape":"String", "documentation":"

The status message of the migration workflow.

" }, "lastStartTime":{ "shape":"Timestamp", "documentation":"

The time at which the migration workflow was last started.

" } } }, "StepActionType":{ "type":"string", "enum":[ "MANUAL", "AUTOMATED" ] }, "StepAutomationConfiguration":{ "type":"structure", "members":{ "scriptLocationS3Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket where the script is located.

" }, "scriptLocationS3Key":{ "shape":"PlatformScriptKey", "documentation":"

The Amazon S3 key for the script location.

" }, "command":{ "shape":"PlatformCommand", "documentation":"

The command to run the script.

" }, "runEnvironment":{ "shape":"RunEnvironment", "documentation":"

The source or target environment.

" }, "targetType":{ "shape":"TargetType", "documentation":"

The servers on which to run the script.

" } }, "documentation":"

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

" }, "StepDescription":{ "type":"string", "max":500, "min":0, "pattern":"[-a-zA-Z0-9_.+, ]*" }, "StepGroupDescription":{ "type":"string", "max":500, "min":0, "pattern":"[-a-zA-Z0-9_.+, ]*" }, "StepGroupId":{ "type":"string", "max":100, "min":1, "pattern":"[a-zA-Z0-9-]+" }, "StepGroupName":{ "type":"string", "max":100, "min":1, "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" }, "StepGroupStatus":{ "type":"string", "enum":[ "AWAITING_DEPENDENCIES", "READY", "IN_PROGRESS", "COMPLETED", "FAILED", "PAUSED", "PAUSING", "USER_ATTENTION_REQUIRED" ] }, "StepId":{ "type":"string", "max":100, "min":1, "pattern":"[a-zA-Z0-9-]+" }, "StepInput":{ "type":"structure", "members":{ "integerValue":{ "shape":"Integer", "documentation":"

The value of the integer.

", "box":true }, "stringValue":{ "shape":"StringValue", "documentation":"

String value.

" }, "listOfStringsValue":{ "shape":"StringList", "documentation":"

List of string values.

" }, "mapOfStringValue":{ "shape":"StringMap", "documentation":"

Map of string values.

" } }, "documentation":"

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.

", "union":true }, "StepInputParameters":{ "type":"map", "key":{"shape":"StepInputParametersKey"}, "value":{"shape":"StepInput"}, "sensitive":true }, "StepInputParametersKey":{ "type":"string", "max":100, "min":1, "pattern":"[a-zA-Z0-9-_ ()]+" }, "StepName":{ "type":"string", "max":100, "min":1, "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" }, "StepOutput":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the step.

" }, "dataType":{ "shape":"DataType", "documentation":"

The data type of the step output.

" }, "required":{ "shape":"Boolean", "documentation":"

Determine if an output is required from a step.

" } }, "documentation":"

The output of the step.

" }, "StepOutputList":{ "type":"list", "member":{"shape":"StepOutput"} }, "StepStatus":{ "type":"string", "enum":[ "AWAITING_DEPENDENCIES", "READY", "IN_PROGRESS", "COMPLETED", "FAILED", "PAUSED", "USER_ATTENTION_REQUIRED" ] }, "StopMigrationWorkflowRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

", "location":"uri", "locationName":"id" } } }, "StopMigrationWorkflowResponse":{ "type":"structure", "members":{ "id":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

" }, "arn":{ "shape":"String", "documentation":"

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

" }, "status":{ "shape":"MigrationWorkflowStatusEnum", "documentation":"

The status of the migration workflow.

" }, "statusMessage":{ "shape":"String", "documentation":"

The status message of the migration workflow.

" }, "lastStopTime":{ "shape":"Timestamp", "documentation":"

The time at which the migration workflow was stopped.

" } } }, "String":{"type":"string"}, "StringList":{ "type":"list", "member":{"shape":"StringListMember"} }, "StringListMember":{ "type":"string", "max":100, "min":0 }, "StringMap":{ "type":"map", "key":{"shape":"StringMapKey"}, "value":{"shape":"StringMapValue"} }, "StringMapKey":{ "type":"string", "max":100, "min":1, "pattern":"[a-zA-Z0-9-_ ()]+" }, "StringMapValue":{ "type":"string", "max":100, "min":0 }, "StringValue":{ "type":"string", "max":100, "min":0 }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"(?!aws:)[a-zA-Z+-=._:/]+" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":0 }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"} }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"ResourceArn", "documentation":"

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

", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagMap", "documentation":"

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

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256, "min":0 }, "TargetType":{ "type":"string", "enum":[ "SINGLE", "ALL", "NONE" ] }, "TemplateId":{ "type":"string", "max":100, "min":1, "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" }, "TemplateInput":{ "type":"structure", "members":{ "inputName":{ "shape":"TemplateInputName", "documentation":"

The name of the template.

" }, "dataType":{ "shape":"DataType", "documentation":"

The data type of the template input.

" }, "required":{ "shape":"Boolean", "documentation":"

Determine if an input is required from the template.

" } }, "documentation":"

The input parameters of a template.

" }, "TemplateInputList":{ "type":"list", "member":{"shape":"TemplateInput"} }, "TemplateInputName":{ "type":"string", "max":100, "min":1, "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" }, "TemplateName":{ "type":"string", "max":100, "min":1, "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" }, "TemplateStatus":{ "type":"string", "enum":["CREATED"] }, "TemplateStepGroupSummary":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The ID of the step group.

" }, "name":{ "shape":"String", "documentation":"

The name of the step group.

" }, "previous":{ "shape":"StringList", "documentation":"

The previous step group.

" }, "next":{ "shape":"StringList", "documentation":"

The next step group.

" } }, "documentation":"

The summary of the step group in the template.

" }, "TemplateStepGroupSummaryList":{ "type":"list", "member":{"shape":"TemplateStepGroupSummary"} }, "TemplateStepSummary":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The ID of the step.

" }, "stepGroupId":{ "shape":"String", "documentation":"

The ID of the step group.

" }, "templateId":{ "shape":"String", "documentation":"

The ID of the template.

" }, "name":{ "shape":"String", "documentation":"

The name of the step.

" }, "stepActionType":{ "shape":"StepActionType", "documentation":"

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.

" }, "targetType":{ "shape":"TargetType", "documentation":"

The servers on which to run the script.

" }, "owner":{ "shape":"Owner", "documentation":"

The owner of the step.

" }, "previous":{ "shape":"StringList", "documentation":"

The previous step.

" }, "next":{ "shape":"StringList", "documentation":"

The next step.

" } }, "documentation":"

The summary of the step.

" }, "TemplateStepSummaryList":{ "type":"list", "member":{"shape":"TemplateStepSummary"} }, "TemplateSummary":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The ID of the template.

" }, "name":{ "shape":"String", "documentation":"

The name of the template.

" }, "arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the template.

" }, "description":{ "shape":"String", "documentation":"

The description of the template.

" } }, "documentation":"

The summary of the template.

" }, "TemplateSummaryList":{ "type":"list", "member":{"shape":"TemplateSummary"} }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The request was denied due to request throttling.

", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true }, "Timestamp":{"type":"timestamp"}, "Tool":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of an AWS service.

" }, "url":{ "shape":"String", "documentation":"

The URL of an AWS service.

" } }, "documentation":"

List of AWS services utilized in a migration workflow.

" }, "ToolsList":{ "type":"list", "member":{"shape":"Tool"} }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"ResourceArn", "documentation":"

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

", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeyList", "documentation":"

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

", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateMigrationWorkflowRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

", "location":"uri", "locationName":"id" }, "name":{ "shape":"UpdateMigrationWorkflowRequestNameString", "documentation":"

The name of the migration workflow.

" }, "description":{ "shape":"UpdateMigrationWorkflowRequestDescriptionString", "documentation":"

The description of the migration workflow.

" }, "inputParameters":{ "shape":"StepInputParameters", "documentation":"

The input parameters required to update a migration workflow.

" }, "stepTargets":{ "shape":"StringList", "documentation":"

The servers on which a step will be run.

" } } }, "UpdateMigrationWorkflowRequestDescriptionString":{ "type":"string", "max":500, "min":0, "pattern":"[-a-zA-Z0-9_.+, ]*" }, "UpdateMigrationWorkflowRequestNameString":{ "type":"string", "max":100, "min":1, "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" }, "UpdateMigrationWorkflowResponse":{ "type":"structure", "members":{ "id":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

" }, "arn":{ "shape":"String", "documentation":"

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

" }, "name":{ "shape":"String", "documentation":"

The name of the migration workflow.

" }, "description":{ "shape":"String", "documentation":"

The description of the migration workflow.

" }, "templateId":{ "shape":"String", "documentation":"

The ID of the template.

" }, "adsApplicationConfigurationId":{ "shape":"String", "documentation":"

The ID of the application configured in Application Discovery Service.

" }, "workflowInputs":{ "shape":"StepInputParameters", "documentation":"

The inputs required to update a migration workflow.

" }, "stepTargets":{ "shape":"StringList", "documentation":"

The servers on which a step will be run.

" }, "status":{ "shape":"MigrationWorkflowStatusEnum", "documentation":"

The status of the migration workflow.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

The time at which the migration workflow was created.

" }, "lastModifiedTime":{ "shape":"Timestamp", "documentation":"

The time at which the migration workflow was last modified.

" }, "tags":{ "shape":"StringMap", "documentation":"

The tags added to the migration workflow.

" } } }, "UpdateWorkflowStepGroupRequest":{ "type":"structure", "required":[ "workflowId", "id" ], "members":{ "workflowId":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

", "location":"querystring", "locationName":"workflowId" }, "id":{ "shape":"StepGroupId", "documentation":"

The ID of the step group.

", "location":"uri", "locationName":"id" }, "name":{ "shape":"StepGroupName", "documentation":"

The name of the step group.

" }, "description":{ "shape":"StepGroupDescription", "documentation":"

The description of the step group.

" }, "next":{ "shape":"StringList", "documentation":"

The next step group.

" }, "previous":{ "shape":"StringList", "documentation":"

The previous step group.

" } } }, "UpdateWorkflowStepGroupResponse":{ "type":"structure", "members":{ "workflowId":{ "shape":"String", "documentation":"

The ID of the migration workflow.

" }, "name":{ "shape":"String", "documentation":"

The name of the step group.

" }, "id":{ "shape":"String", "documentation":"

The ID of the step group.

" }, "description":{ "shape":"String", "documentation":"

The description of the step group.

" }, "tools":{ "shape":"ToolsList", "documentation":"

List of AWS services utilized in a migration workflow.

" }, "next":{ "shape":"StringList", "documentation":"

The next step group.

" }, "previous":{ "shape":"StringList", "documentation":"

The previous step group.

" }, "lastModifiedTime":{ "shape":"Timestamp", "documentation":"

The time at which the step group was last modified.

" } } }, "UpdateWorkflowStepRequest":{ "type":"structure", "required":[ "id", "stepGroupId", "workflowId" ], "members":{ "id":{ "shape":"StepId", "documentation":"

The ID of the step.

", "location":"uri", "locationName":"id" }, "stepGroupId":{ "shape":"StepGroupId", "documentation":"

The ID of the step group.

" }, "workflowId":{ "shape":"MigrationWorkflowId", "documentation":"

The ID of the migration workflow.

" }, "name":{ "shape":"StepName", "documentation":"

The name of the step.

" }, "description":{ "shape":"StepDescription", "documentation":"

The description of the step.

" }, "stepActionType":{ "shape":"StepActionType", "documentation":"

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.

" }, "workflowStepAutomationConfiguration":{ "shape":"WorkflowStepAutomationConfiguration", "documentation":"

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

" }, "stepTarget":{ "shape":"StringList", "documentation":"

The servers on which a step will be run.

" }, "outputs":{ "shape":"WorkflowStepOutputList", "documentation":"

The outputs of a step.

" }, "previous":{ "shape":"StringList", "documentation":"

The previous step.

" }, "next":{ "shape":"StringList", "documentation":"

The next step.

" }, "status":{ "shape":"StepStatus", "documentation":"

The status of the step.

" } } }, "UpdateWorkflowStepResponse":{ "type":"structure", "members":{ "id":{ "shape":"StepId", "documentation":"

The ID of the step.

" }, "stepGroupId":{ "shape":"String", "documentation":"

The ID of the step group.

" }, "workflowId":{ "shape":"String", "documentation":"

The ID of the migration workflow.

" }, "name":{ "shape":"String", "documentation":"

The name of the step.

" } } }, "ValidationException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

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

", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true, "retryable":{"throttling":false} }, "WorkflowStepAutomationConfiguration":{ "type":"structure", "members":{ "scriptLocationS3Bucket":{ "shape":"S3Bucket", "documentation":"

The Amazon S3 bucket where the script is located.

" }, "scriptLocationS3Key":{ "shape":"PlatformScriptKey", "documentation":"

The Amazon S3 key for the script location.

" }, "command":{ "shape":"PlatformCommand", "documentation":"

The command required to run the script.

" }, "runEnvironment":{ "shape":"RunEnvironment", "documentation":"

The source or target environment.

" }, "targetType":{ "shape":"TargetType", "documentation":"

The servers on which to run the script.

" } }, "documentation":"

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

" }, "WorkflowStepGroupSummary":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The ID of the step group.

" }, "name":{ "shape":"String", "documentation":"

The name of the step group.

" }, "owner":{ "shape":"Owner", "documentation":"

The owner of the step group.

" }, "status":{ "shape":"StepGroupStatus", "documentation":"

The status of the step group.

" }, "previous":{ "shape":"StringList", "documentation":"

The previous step group.

" }, "next":{ "shape":"StringList", "documentation":"

The next step group.

" } }, "documentation":"

The summary of a step group in a workflow.

" }, "WorkflowStepGroupsSummaryList":{ "type":"list", "member":{"shape":"WorkflowStepGroupSummary"} }, "WorkflowStepOutput":{ "type":"structure", "members":{ "name":{ "shape":"WorkflowStepOutputName", "documentation":"

The name of the step.

" }, "dataType":{ "shape":"DataType", "documentation":"

The data type of the output.

" }, "required":{ "shape":"Boolean", "documentation":"

Determine if an output is required from a step.

" }, "value":{ "shape":"WorkflowStepOutputUnion", "documentation":"

The value of the output.

" } }, "documentation":"

The output of a step.

" }, "WorkflowStepOutputList":{ "type":"list", "member":{"shape":"WorkflowStepOutput"} }, "WorkflowStepOutputName":{ "type":"string", "max":100, "min":1, "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" }, "WorkflowStepOutputUnion":{ "type":"structure", "members":{ "integerValue":{ "shape":"Integer", "documentation":"

The integer value.

", "box":true }, "stringValue":{ "shape":"StringValue", "documentation":"

The string value.

" }, "listOfStringValue":{ "shape":"StringList", "documentation":"

The list of string value.

" } }, "documentation":"

A structure to hold multiple values of an output.

", "union":true }, "WorkflowStepSummary":{ "type":"structure", "members":{ "stepId":{ "shape":"String", "documentation":"

The ID of the step.

" }, "name":{ "shape":"String", "documentation":"

The name of the step.

" }, "stepActionType":{ "shape":"StepActionType", "documentation":"

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.

" }, "owner":{ "shape":"Owner", "documentation":"

The owner of the step.

" }, "previous":{ "shape":"StringList", "documentation":"

The previous step.

" }, "next":{ "shape":"StringList", "documentation":"

The next step.

" }, "status":{ "shape":"StepStatus", "documentation":"

The status of the step.

" }, "statusMessage":{ "shape":"String", "documentation":"

The status message of the migration workflow.

" }, "noOfSrvCompleted":{ "shape":"Integer", "documentation":"

The number of servers that have been migrated.

" }, "noOfSrvFailed":{ "shape":"Integer", "documentation":"

The number of servers that have failed to migrate.

" }, "totalNoOfSrv":{ "shape":"Integer", "documentation":"

The total number of servers that have been migrated.

" }, "description":{ "shape":"String", "documentation":"

The description of the step.

" }, "scriptLocation":{ "shape":"String", "documentation":"

The location of the script.

" } }, "documentation":"

The summary of the step in a migration workflow.

" }, "WorkflowStepsSummaryList":{ "type":"list", "member":{"shape":"WorkflowStepSummary"} } }, "documentation":"

This API reference provides descriptions, syntax, and other details about each of the actions and data types for AWS Migration Hub Orchestrator. he topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using.

" }