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.
440 441 442 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 440 def initialize(*args) super end |
Instance Method Details
#create_template(params = {}) ⇒ Types::CreateTemplateResponse
Creates a migration workflow template.
503 504 505 506 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 503 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.
595 596 597 598 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 595 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.
690 691 692 693 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 690 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.
752 753 754 755 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 752 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.
774 775 776 777 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 774 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.
807 808 809 810 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 807 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.
838 839 840 841 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 838 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.
864 865 866 867 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 864 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.
920 921 922 923 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 920 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.
987 988 989 990 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 987 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.
1041 1042 1043 1044 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1041 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.
1116 1117 1118 1119 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1116 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.
1208 1209 1210 1211 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1208 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.
1266 1267 1268 1269 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1266 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.
1308 1309 1310 1311 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1308 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.
1337 1338 1339 1340 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1337 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.
1383 1384 1385 1386 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1383 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.
1438 1439 1440 1441 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1438 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.
1483 1484 1485 1486 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1483 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.
1531 1532 1533 1534 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1531 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.
1590 1591 1592 1593 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1590 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.
1653 1654 1655 1656 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1653 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.
1695 1696 1697 1698 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1695 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.
1731 1732 1733 1734 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1731 def start_workflow(params = {}, = {}) req = build_request(:start_workflow, params) req.send_request() end |
#stop_workflow(params = {}) ⇒ Types::StopMigrationWorkflowResponse
Stop an ongoing migration workflow.
1767 1768 1769 1770 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1767 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).
1797 1798 1799 1800 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1797 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes the tags for a resource.
1824 1825 1826 1827 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1824 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_template(params = {}) ⇒ Types::UpdateTemplateResponse
Updates a migration workflow template.
1873 1874 1875 1876 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1873 def update_template(params = {}, = {}) req = build_request(:update_template, params) req.send_request() end |
#update_workflow(params = {}) ⇒ Types::UpdateMigrationWorkflowResponse
Update a migration workflow.
1956 1957 1958 1959 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1956 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.
2059 2060 2061 2062 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 2059 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.
2125 2126 2127 2128 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 2125 def update_workflow_step_group(params = {}, = {}) req = build_request(:update_workflow_step_group, params) req.send_request() end |