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.
385 386 387 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#create_template(params = {}) ⇒ Types::CreateTemplateResponse
Creates a migration workflow template.
448 449 450 451 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 448 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.
540 541 542 543 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 540 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.
635 636 637 638 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 635 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.
697 698 699 700 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 697 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.
719 720 721 722 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 719 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.
752 753 754 755 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 752 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.
783 784 785 786 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 783 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.
809 810 811 812 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 809 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.
865 866 867 868 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 865 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.
932 933 934 935 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 932 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.
986 987 988 989 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 986 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.
1061 1062 1063 1064 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1061 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.
1153 1154 1155 1156 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1153 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.
1211 1212 1213 1214 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1211 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.
1253 1254 1255 1256 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1253 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.
1282 1283 1284 1285 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1282 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.
1328 1329 1330 1331 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1328 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.
1383 1384 1385 1386 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1383 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.
1428 1429 1430 1431 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1428 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.
1476 1477 1478 1479 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1476 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.
1535 1536 1537 1538 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1535 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.
1598 1599 1600 1601 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1598 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.
1640 1641 1642 1643 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1640 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.
1676 1677 1678 1679 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1676 def start_workflow(params = {}, = {}) req = build_request(:start_workflow, params) req.send_request() end |
#stop_workflow(params = {}) ⇒ Types::StopMigrationWorkflowResponse
Stop an ongoing migration workflow.
1712 1713 1714 1715 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1712 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).
1742 1743 1744 1745 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1742 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes the tags for a resource.
1769 1770 1771 1772 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1769 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_template(params = {}) ⇒ Types::UpdateTemplateResponse
Updates a migration workflow template.
1818 1819 1820 1821 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1818 def update_template(params = {}, = {}) req = build_request(:update_template, params) req.send_request() end |
#update_workflow(params = {}) ⇒ Types::UpdateMigrationWorkflowResponse
Update a migration workflow.
1901 1902 1903 1904 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1901 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.
2004 2005 2006 2007 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 2004 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.
2070 2071 2072 2073 |
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 2070 def update_workflow_step_group(params = {}, = {}) req = build_request(:update_workflow_step_group, params) req.send_request() end |