aws-elixir

View Source AWS.MigrationHubOrchestrator (aws-elixir v1.0.4)

This API reference provides descriptions, syntax, and other details about each of the actions and data types for AWS Migration Hub Orchestrator.

The topic for each action shows the API request parameters and responses. 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.

Link to this section Summary

Functions

create_template(client, input, options \\ [])

Creates a migration workflow template.

create_workflow(client, input, options \\ [])

Create a workflow to orchestrate your migrations.

create_workflow_step(client, input, options \\ [])

Create a step in the migration workflow.

create_workflow_step_group(client, input, options \\ [])

Create a step group in a migration workflow.

delete_template(client, id, input, options \\ [])

Deletes a migration workflow template.

delete_workflow(client, id, input, options \\ [])

Delete a migration workflow.

delete_workflow_step(client, id, input, options \\ [])

Delete a step in a migration workflow.

delete_workflow_step_group(client, id, input, options \\ [])

Delete a step group in a migration workflow.

get_template(client, id, options \\ [])

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

get_template_step(client, id, step_group_id, template_id, options \\ [])

Get a specific step in a template.

get_template_step_group(client, id, template_id, options \\ [])

Get a step group in a template.

get_workflow(client, id, options \\ [])

Get migration workflow.

get_workflow_step(client, id, step_group_id, workflow_id, options \\ [])

Get a step in the migration workflow.

get_workflow_step_group(client, id, workflow_id, options \\ [])

Get the step group of a migration workflow.

list_plugins(client, max_results \\ nil, next_token \\ nil, options \\ [])

List AWS Migration Hub Orchestrator plugins.

list_tags_for_resource(client, resource_arn, options \\ [])

List the tags added to a resource.

list_template_step_groups(client, template_id, max_results \\ nil, next_token \\ nil, options \\ [])

List the step groups in a template.

list_template_steps(client, max_results \\ nil, next_token \\ nil, step_group_id, template_id, options \\ [])

List the steps in a template.

list_templates(client, max_results \\ nil, name \\ nil, next_token \\ nil, options \\ [])

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

list_workflow_step_groups(client, max_results \\ nil, next_token \\ nil, workflow_id, options \\ [])

List the step groups in a migration workflow.

list_workflow_steps(client, step_group_id, workflow_id, max_results \\ nil, next_token \\ nil, options \\ [])

List the steps in a workflow.

list_workflows(client, ads_application_configuration_name \\ nil, max_results \\ nil, name \\ nil, next_token \\ nil, status \\ nil, template_id \\ nil, options \\ [])

List the migration workflows.

metadata()
retry_workflow_step(client, id, input, options \\ [])

Retry a failed step in a migration workflow.

start_workflow(client, id, input, options \\ [])

Start a migration workflow.

stop_workflow(client, id, input, options \\ [])

Stop an ongoing migration workflow.

tag_resource(client, resource_arn, input, options \\ [])

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

untag_resource(client, resource_arn, input, options \\ [])

Deletes the tags for a resource.

update_template(client, id, input, options \\ [])

Updates a migration workflow template.

update_workflow(client, id, input, options \\ [])

Update a migration workflow.

update_workflow_step(client, id, input, options \\ [])

Update a step in a migration workflow.

update_workflow_step_group(client, id, input, options \\ [])

Update the step group in a migration workflow.

Link to this section Functions

Link to this function

create_template(client, input, options \\ [])

View Source

Creates a migration workflow template.

Link to this function

create_workflow(client, input, options \\ [])

View Source

Create a workflow to orchestrate your migrations.

Link to this function

create_workflow_step(client, input, options \\ [])

View Source

Create a step in the migration workflow.

Link to this function

create_workflow_step_group(client, input, options \\ [])

View Source

Create a step group in a migration workflow.

Link to this function

delete_template(client, id, input, options \\ [])

View Source

Deletes a migration workflow template.

Link to this function

delete_workflow(client, id, input, options \\ [])

View Source

Delete a migration workflow.

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

Link to this function

delete_workflow_step(client, id, input, options \\ [])

View Source

Delete a step in a migration workflow.

Pause the workflow to delete a running step.

Link to this function

delete_workflow_step_group(client, id, input, options \\ [])

View Source

Delete a step group in a migration workflow.

Link to this function

get_template(client, id, options \\ [])

View Source

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

Link to this function

get_template_step(client, id, step_group_id, template_id, options \\ [])

View Source

Get a specific step in a template.

Link to this function

get_template_step_group(client, id, template_id, options \\ [])

View Source

Get a step group in a template.

Link to this function

get_workflow(client, id, options \\ [])

View Source

Get migration workflow.

Link to this function

get_workflow_step(client, id, step_group_id, workflow_id, options \\ [])

View Source

Get a step in the migration workflow.

Link to this function

get_workflow_step_group(client, id, workflow_id, options \\ [])

View Source

Get the step group of a migration workflow.

Link to this function

list_plugins(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

List AWS Migration Hub Orchestrator plugins.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

List the tags added to a resource.

Link to this function

list_template_step_groups(client, template_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

List the step groups in a template.

Link to this function

list_template_steps(client, max_results \\ nil, next_token \\ nil, step_group_id, template_id, options \\ [])

View Source

List the steps in a template.

Link to this function

list_templates(client, max_results \\ nil, name \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_workflow_step_groups(client, max_results \\ nil, next_token \\ nil, workflow_id, options \\ [])

View Source

List the step groups in a migration workflow.

Link to this function

list_workflow_steps(client, step_group_id, workflow_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

List the steps in a workflow.

Link to this function

list_workflows(client, ads_application_configuration_name \\ nil, max_results \\ nil, name \\ nil, next_token \\ nil, status \\ nil, template_id \\ nil, options \\ [])

View Source

List the migration workflows.

Link to this function

metadata()

View Source
Link to this function

retry_workflow_step(client, id, input, options \\ [])

View Source

Retry a failed step in a migration workflow.

Link to this function

start_workflow(client, id, input, options \\ [])

View Source

Start a migration workflow.

Link to this function

stop_workflow(client, id, input, options \\ [])

View Source

Stop an ongoing migration workflow.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

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

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Deletes the tags for a resource.

Link to this function

update_template(client, id, input, options \\ [])

View Source

Updates a migration workflow template.

Link to this function

update_workflow(client, id, input, options \\ [])

View Source

Update a migration workflow.

Link to this function

update_workflow_step(client, id, input, options \\ [])

View Source

Update a step in a migration workflow.

Link to this function

update_workflow_step_group(client, id, input, options \\ [])

View Source

Update the step group in a migration workflow.