workflows

Creates, updates, deletes, gets or lists a workflows resource.

Overview

Name	workflows
Type	Resource
Id	aws.migrationhuborchestrator.workflows

Fields

The following fields are returned by SELECT queries:

get_workflow

Name	Datatype	Description
id	string	The ID of the migration workflow. (pattern: <code>[a-zA-Z0-9-]+</code>)
name	string	The name of the migration workflow.
ads_application_configuration_id	string	The configuration ID of the application configured in Application Discovery Service.
ads_application_name	string	The name of the application configured in Application Discovery Service.
arn	string	The Amazon Resource Name (ARN) of the migration workflow.
completed_steps	integer	Get a list of completed steps in the migration workflow.
creation_time	string (date-time)	The time at which the migration workflow was created.
description	string	The description of the migration workflow.
end_time	string (date-time)	The time at which the migration workflow ended.
last_modified_time	string (date-time)	The time at which the migration workflow was last modified.
last_start_time	string (date-time)	The time at which the migration workflow was last started.
last_stop_time	string (date-time)	The time at which the migration workflow was last stopped.
status	string	The status of the migration workflow. (CREATING, NOT_STARTED, CREATION_FAILED, STARTING, IN_PROGRESS, WORKFLOW_FAILED, PAUSED, PAUSING, PAUSING_FAILED, USER_ATTENTION_REQUIRED, DELETING, DELETION_FAILED, DELETED, COMPLETED)
status_message	string	The status message of the migration workflow.
tags	object	The tags added to the migration workflow.
template_id	string	The ID of the template.
tools	array	List of AWS services utilized in a migration workflow.
total_steps	integer	The total number of steps in the migration workflow.
workflow_bucket	string	The Amazon S3 bucket where the migration logs are stored.
workflow_inputs	object	The inputs required for creating the migration workflow.

list_workflows

Name	Datatype	Description
id	string	The ID of the migration workflow. (pattern: <code>[a-zA-Z0-9-]+</code>)
name	string	The name of the migration workflow.
ads_application_configuration_name	string	The name of the application configured in Application Discovery Service.
completed_steps	integer	The steps completed in the migration workflow.
creation_time	string (date-time)	The time at which the migration workflow was created.
end_time	string (date-time)	The time at which the migration workflow ended.
status	string	The status of the migration workflow. (CREATING, NOT_STARTED, CREATION_FAILED, STARTING, IN_PROGRESS, WORKFLOW_FAILED, PAUSED, PAUSING, PAUSING_FAILED, USER_ATTENTION_REQUIRED, DELETING, DELETION_FAILED, DELETED, COMPLETED)
status_message	string	The status message of the migration workflow.
template_id	string	The ID of the template.
total_steps	integer	All the steps in a migration workflow.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_workflow	select	id, region		Get migration workflow.
list_workflows	select	region	maxResults, nextToken, templateId, adsApplicationConfigurationName, status, name	List the migration workflows.
create_workflow	insert	region, name, templateId, inputParameters		Create a workflow to orchestrate your migrations.
update_workflow	update	id, region		Update a migration workflow.
delete_workflow	delete	id, region		Delete a migration workflow. You must pause a running workflow in Migration Hub Orchestrator console to delete it.
retry_workflow_step	exec	workflowId, stepGroupId, id, region		Retry a failed step in a migration workflow.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The ID of the step.
region	string	AWS region (default: us-east-1)
stepGroupId	string	The ID of the step group.
workflowId	string	The ID of the migration workflow.
adsApplicationConfigurationName	string	The name of the application configured in Application Discovery Service.
maxResults	integer	The maximum number of results that can be returned.
name	string	The name of the migration workflow.
nextToken	string	The pagination token.
status	string	The status of the migration workflow.
templateId	string	The ID of the template.

SELECT examples

get_workflow

Get migration workflow.

SELECT
id,
name,
ads_application_configuration_id,
ads_application_name,
arn,
completed_steps,
creation_time,
description,
end_time,
last_modified_time,
last_start_time,
last_stop_time,
status,
status_message,
tags,
template_id,
tools,
total_steps,
workflow_bucket,
workflow_inputs
FROM aws.migrationhuborchestrator.workflows
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_workflows

List the migration workflows.

SELECT
id,
name,
ads_application_configuration_name,
completed_steps,
creation_time,
end_time,
status,
status_message,
template_id,
total_steps
FROM aws.migrationhuborchestrator.workflows
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND templateId = '{{ templateId }}'
AND adsApplicationConfigurationName = '{{ adsApplicationConfigurationName }}'
AND status = '{{ status }}'
AND name = '{{ name }}'
;

INSERT examples

create_workflow

Create a workflow to orchestrate your migrations.

INSERT INTO aws.migrationhuborchestrator.workflows (
name,
description,
templateId,
applicationConfigurationId,
inputParameters,
stepTargets,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ templateId }}' /* required */,
'{{ applicationConfigurationId }}',
'{{ inputParameters }}' /* required */,
'{{ stepTargets }}',
'{{ tags }}',
'{{ region }}'
RETURNING
id,
name,
ads_application_configuration_id,
arn,
creation_time,
description,
status,
step_targets,
tags,
template_id,
workflow_inputs
;

Manifest

# Description fields are for documentation purposes
- name: workflows
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the workflows resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: templateId
    value: "{{ templateId }}"
  - name: applicationConfigurationId
    value: "{{ applicationConfigurationId }}"
  - name: inputParameters
    value: "{{ inputParameters }}"
  - name: stepTargets
    value:
      - "{{ stepTargets }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_workflow

Update a migration workflow.

UPDATE aws.migrationhuborchestrator.workflows
SET 
name = '{{ name }}',
description = '{{ description }}',
inputParameters = '{{ inputParameters }}',
stepTargets = '{{ stepTargets }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
ads_application_configuration_id,
arn,
creation_time,
description,
last_modified_time,
status,
step_targets,
tags,
template_id,
workflow_inputs;

DELETE examples

delete_workflow

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

DELETE FROM aws.migrationhuborchestrator.workflows
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

retry_workflow_step

Retry a failed step in a migration workflow.

EXEC aws.migrationhuborchestrator.workflows.retry_workflow_step 
@workflowId='{{ workflowId }}' --required, 
@stepGroupId='{{ stepGroupId }}' --required, 
@id='{{ id }}' --required, 
@region='{{ region }}' --required
;