Class: Aws::MigrationHubOrchestrator::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::MigrationHubOrchestrator::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb
Overview
An API client for MigrationHubOrchestrator. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::MigrationHubOrchestrator::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_workflow(params = {}) ⇒ Types::CreateMigrationWorkflowResponse
Create a workflow to orchestrate your migrations.
-
#create_workflow_step(params = {}) ⇒ Types::CreateWorkflowStepResponse
Create a step in the migration workflow.
-
#create_workflow_step_group(params = {}) ⇒ Types::CreateWorkflowStepGroupResponse
Create a step group in a migration workflow.
-
#delete_workflow(params = {}) ⇒ Types::DeleteMigrationWorkflowResponse
Delete a migration workflow.
-
#delete_workflow_step(params = {}) ⇒ Struct
Delete a step in a migration workflow.
-
#delete_workflow_step_group(params = {}) ⇒ Struct
Delete a step group in a migration workflow.
-
#get_template(params = {}) ⇒ Types::GetMigrationWorkflowTemplateResponse
Get the template you want to use for creating a migration workflow.
-
#get_template_step(params = {}) ⇒ Types::GetTemplateStepResponse
Get a specific step in a template.
-
#get_template_step_group(params = {}) ⇒ Types::GetTemplateStepGroupResponse
Get a step group in a template.
-
#get_workflow(params = {}) ⇒ Types::GetMigrationWorkflowResponse
Get migration workflow.
-
#get_workflow_step(params = {}) ⇒ Types::GetWorkflowStepResponse
Get a step in the migration workflow.
-
#get_workflow_step_group(params = {}) ⇒ Types::GetWorkflowStepGroupResponse
Get the step group of a migration workflow.
-
#list_plugins(params = {}) ⇒ Types::ListPluginsResponse
List AWS Migration Hub Orchestrator plugins.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List the tags added to a resource.
-
#list_template_step_groups(params = {}) ⇒ Types::ListTemplateStepGroupsResponse
List the step groups in a template.
-
#list_template_steps(params = {}) ⇒ Types::ListTemplateStepsResponse
List the steps in a template.
-
#list_templates(params = {}) ⇒ Types::ListMigrationWorkflowTemplatesResponse
List the templates available in Migration Hub Orchestrator to create a migration workflow.
-
#list_workflow_step_groups(params = {}) ⇒ Types::ListWorkflowStepGroupsResponse
List the step groups in a migration workflow.
-
#list_workflow_steps(params = {}) ⇒ Types::ListWorkflowStepsResponse
List the steps in a workflow.
-
#list_workflows(params = {}) ⇒ Types::ListMigrationWorkflowsResponse
List the migration workflows.
-
#retry_workflow_step(params = {}) ⇒ Types::RetryWorkflowStepResponse
Retry a failed step in a migration workflow.
-
#start_workflow(params = {}) ⇒ Types::StartMigrationWorkflowResponse
Start a migration workflow.
-
#stop_workflow(params = {}) ⇒ Types::StopMigrationWorkflowResponse
Stop an ongoing migration workflow.
-
#tag_resource(params = {}) ⇒ Struct
Tag a resource by specifying its Amazon Resource Name (ARN).
-
#untag_resource(params = {}) ⇒ Struct
Deletes the tags for a resource.
-
#update_workflow(params = {}) ⇒ Types::UpdateMigrationWorkflowResponse
Update a migration workflow.
-
#update_workflow_step(params = {}) ⇒ Types::UpdateWorkflowStepResponse
Update a step in a migration workflow.
-
#update_workflow_step_group(params = {}) ⇒ Types::UpdateWorkflowStepGroupResponse
Update the step group in a migration workflow.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
365 366 367 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 365 def initialize(*args) super end |
Instance Method Details
#create_workflow(params = {}) ⇒ Types::CreateMigrationWorkflowResponse
Create a workflow to orchestrate your migrations.
458 459 460 461 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 458 def create_workflow(params = {}, = {}) req = build_request(:create_workflow, params) req.send_request() end |
#create_workflow_step(params = {}) ⇒ Types::CreateWorkflowStepResponse
Create a step in the migration workflow.
553 554 555 556 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 553 def create_workflow_step(params = {}, = {}) req = build_request(:create_workflow_step, params) req.send_request() end |
#create_workflow_step_group(params = {}) ⇒ Types::CreateWorkflowStepGroupResponse
Create a step group in a migration workflow.
615 616 617 618 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 615 def create_workflow_step_group(params = {}, = {}) req = build_request(:create_workflow_step_group, params) req.send_request() end |
#delete_workflow(params = {}) ⇒ Types::DeleteMigrationWorkflowResponse
Delete a migration workflow. You must pause a running workflow in Migration Hub Orchestrator console to delete it.
648 649 650 651 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 648 def delete_workflow(params = {}, = {}) req = build_request(:delete_workflow, params) req.send_request() end |
#delete_workflow_step(params = {}) ⇒ Struct
Delete a step in a migration workflow. Pause the workflow to delete a running step.
679 680 681 682 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 679 def delete_workflow_step(params = {}, = {}) req = build_request(:delete_workflow_step, params) req.send_request() end |
#delete_workflow_step_group(params = {}) ⇒ Struct
Delete a step group in a migration workflow.
705 706 707 708 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 705 def delete_workflow_step_group(params = {}, = {}) req = build_request(:delete_workflow_step_group, params) req.send_request() end |
#get_template(params = {}) ⇒ Types::GetMigrationWorkflowTemplateResponse
Get the template you want to use for creating a migration workflow.
750 751 752 753 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 750 def get_template(params = {}, = {}) req = build_request(:get_template, params) req.send_request() end |
#get_template_step(params = {}) ⇒ Types::GetTemplateStepResponse
Get a specific step in a template.
817 818 819 820 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 817 def get_template_step(params = {}, = {}) req = build_request(:get_template_step, params) req.send_request() end |
#get_template_step_group(params = {}) ⇒ Types::GetTemplateStepGroupResponse
Get a step group in a template.
871 872 873 874 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 871 def get_template_step_group(params = {}, = {}) req = build_request(:get_template_step_group, params) req.send_request() end |
#get_workflow(params = {}) ⇒ Types::GetMigrationWorkflowResponse
Get migration workflow.
946 947 948 949 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 946 def get_workflow(params = {}, = {}) req = build_request(:get_workflow, params) req.send_request() end |
#get_workflow_step(params = {}) ⇒ Types::GetWorkflowStepResponse
Get a step in the migration workflow.
1038 1039 1040 1041 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1038 def get_workflow_step(params = {}, = {}) req = build_request(:get_workflow_step, params) req.send_request() end |
#get_workflow_step_group(params = {}) ⇒ Types::GetWorkflowStepGroupResponse
Get the step group of a migration workflow.
1096 1097 1098 1099 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1096 def get_workflow_step_group(params = {}, = {}) req = build_request(:get_workflow_step_group, params) req.send_request() end |
#list_plugins(params = {}) ⇒ Types::ListPluginsResponse
List AWS Migration Hub Orchestrator plugins.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1138 1139 1140 1141 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1138 def list_plugins(params = {}, = {}) req = build_request(:list_plugins, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List the tags added to a resource.
1167 1168 1169 1170 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1167 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_template_step_groups(params = {}) ⇒ Types::ListTemplateStepGroupsResponse
List the step groups in a template.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1213 1214 1215 1216 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1213 def list_template_step_groups(params = {}, = {}) req = build_request(:list_template_step_groups, params) req.send_request() end |
#list_template_steps(params = {}) ⇒ Types::ListTemplateStepsResponse
List the steps in a template.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1268 1269 1270 1271 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1268 def list_template_steps(params = {}, = {}) req = build_request(:list_template_steps, params) req.send_request() end |
#list_templates(params = {}) ⇒ Types::ListMigrationWorkflowTemplatesResponse
List the templates available in Migration Hub Orchestrator to create a migration workflow.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1313 1314 1315 1316 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1313 def list_templates(params = {}, = {}) req = build_request(:list_templates, params) req.send_request() end |
#list_workflow_step_groups(params = {}) ⇒ Types::ListWorkflowStepGroupsResponse
List the step groups in a migration workflow.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1361 1362 1363 1364 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1361 def list_workflow_step_groups(params = {}, = {}) req = build_request(:list_workflow_step_groups, params) req.send_request() end |
#list_workflow_steps(params = {}) ⇒ Types::ListWorkflowStepsResponse
List the steps in a workflow.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1420 1421 1422 1423 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1420 def list_workflow_steps(params = {}, = {}) req = build_request(:list_workflow_steps, params) req.send_request() end |
#list_workflows(params = {}) ⇒ Types::ListMigrationWorkflowsResponse
List the migration workflows.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1483 1484 1485 1486 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1483 def list_workflows(params = {}, = {}) req = build_request(:list_workflows, params) req.send_request() end |
#retry_workflow_step(params = {}) ⇒ Types::RetryWorkflowStepResponse
Retry a failed step in a migration workflow.
1525 1526 1527 1528 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1525 def retry_workflow_step(params = {}, = {}) req = build_request(:retry_workflow_step, params) req.send_request() end |
#start_workflow(params = {}) ⇒ Types::StartMigrationWorkflowResponse
Start a migration workflow.
1561 1562 1563 1564 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1561 def start_workflow(params = {}, = {}) req = build_request(:start_workflow, params) req.send_request() end |
#stop_workflow(params = {}) ⇒ Types::StopMigrationWorkflowResponse
Stop an ongoing migration workflow.
1597 1598 1599 1600 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1597 def stop_workflow(params = {}, = {}) req = build_request(:stop_workflow, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Tag a resource by specifying its Amazon Resource Name (ARN).
1627 1628 1629 1630 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1627 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes the tags for a resource.
1654 1655 1656 1657 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1654 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_workflow(params = {}) ⇒ Types::UpdateMigrationWorkflowResponse
Update a migration workflow.
1737 1738 1739 1740 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1737 def update_workflow(params = {}, = {}) req = build_request(:update_workflow, params) req.send_request() end |
#update_workflow_step(params = {}) ⇒ Types::UpdateWorkflowStepResponse
Update a step in a migration workflow.
1840 1841 1842 1843 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1840 def update_workflow_step(params = {}, = {}) req = build_request(:update_workflow_step, params) req.send_request() end |
#update_workflow_step_group(params = {}) ⇒ Types::UpdateWorkflowStepGroupResponse
Update the step group in a migration workflow.
1906 1907 1908 1909 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1906 def update_workflow_step_group(params = {}, = {}) req = build_request(:update_workflow_step_group, params) req.send_request() end |