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_template(params = {}) ⇒ Types::CreateTemplateResponse
Creates a migration workflow template.
-
#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_template(params = {}) ⇒ Struct
Deletes a migration workflow template.
-
#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_template(params = {}) ⇒ Types::UpdateTemplateResponse
Updates a migration workflow template.
-
#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.
446 447 448 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 446 def initialize(*args) super end |
Instance Method Details
#create_template(params = {}) ⇒ Types::CreateTemplateResponse
Creates a migration workflow template.
509 510 511 512 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 509 def create_template(params = {}, = {}) req = build_request(:create_template, params) req.send_request() end |
#create_workflow(params = {}) ⇒ Types::CreateMigrationWorkflowResponse
Create a workflow to orchestrate your migrations.
601 602 603 604 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 601 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.
696 697 698 699 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 696 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.
758 759 760 761 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 758 def create_workflow_step_group(params = {}, = {}) req = build_request(:create_workflow_step_group, params) req.send_request() end |
#delete_template(params = {}) ⇒ Struct
Deletes a migration workflow template.
780 781 782 783 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 780 def delete_template(params = {}, = {}) req = build_request(:delete_template, 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.
813 814 815 816 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 813 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.
844 845 846 847 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 844 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.
870 871 872 873 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 870 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.
926 927 928 929 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 926 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.
993 994 995 996 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 993 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.
1047 1048 1049 1050 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1047 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.
1122 1123 1124 1125 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1122 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.
1214 1215 1216 1217 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1214 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.
1272 1273 1274 1275 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1272 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.
1314 1315 1316 1317 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1314 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.
1343 1344 1345 1346 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1343 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.
1389 1390 1391 1392 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1389 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.
1444 1445 1446 1447 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1444 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.
1489 1490 1491 1492 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1489 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.
1537 1538 1539 1540 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1537 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.
1596 1597 1598 1599 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1596 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.
1659 1660 1661 1662 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1659 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.
1701 1702 1703 1704 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1701 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.
1737 1738 1739 1740 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1737 def start_workflow(params = {}, = {}) req = build_request(:start_workflow, params) req.send_request() end |
#stop_workflow(params = {}) ⇒ Types::StopMigrationWorkflowResponse
Stop an ongoing migration workflow.
1773 1774 1775 1776 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1773 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).
1803 1804 1805 1806 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1803 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes the tags for a resource.
1830 1831 1832 1833 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1830 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_template(params = {}) ⇒ Types::UpdateTemplateResponse
Updates a migration workflow template.
1879 1880 1881 1882 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1879 def update_template(params = {}, = {}) req = build_request(:update_template, params) req.send_request() end |
#update_workflow(params = {}) ⇒ Types::UpdateMigrationWorkflowResponse
Update a migration workflow.
1962 1963 1964 1965 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1962 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.
2065 2066 2067 2068 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 2065 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.
2131 2132 2133 2134 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 2131 def update_workflow_step_group(params = {}, = {}) req = build_request(:update_workflow_step_group, params) req.send_request() end |