Class: Aws::MigrationHub::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::MigrationHub::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb
Overview
An API client for MigrationHub. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::MigrationHub::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
-
#associate_created_artifact(params = {}) ⇒ Struct
Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool.
-
#associate_discovered_resource(params = {}) ⇒ Struct
Associates a discovered resource ID from Application Discovery Service with a migration task.
-
#associate_source_resource(params = {}) ⇒ Struct
Associates a source resource with a migration task.
-
#create_progress_update_stream(params = {}) ⇒ Struct
Creates a progress update stream which is an AWS resource used for access control as well as a namespace for migration task names that is implicitly linked to your AWS account.
-
#delete_progress_update_stream(params = {}) ⇒ Struct
Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control.
-
#describe_application_state(params = {}) ⇒ Types::DescribeApplicationStateResult
Gets the migration status of an application.
-
#describe_migration_task(params = {}) ⇒ Types::DescribeMigrationTaskResult
Retrieves a list of all attributes associated with a specific migration task.
-
#disassociate_created_artifact(params = {}) ⇒ Struct
Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated.
-
#disassociate_discovered_resource(params = {}) ⇒ Struct
Disassociate an Application Discovery Service discovered resource from a migration task.
-
#disassociate_source_resource(params = {}) ⇒ Struct
Removes the association between a source resource and a migration task.
-
#import_migration_task(params = {}) ⇒ Struct
Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool.
-
#list_application_states(params = {}) ⇒ Types::ListApplicationStatesResult
Lists all the migration statuses for your applications.
-
#list_created_artifacts(params = {}) ⇒ Types::ListCreatedArtifactsResult
Lists the created artifacts attached to a given migration task in an update stream.
-
#list_discovered_resources(params = {}) ⇒ Types::ListDiscoveredResourcesResult
Lists discovered resources associated with the given
MigrationTask
. -
#list_migration_task_updates(params = {}) ⇒ Types::ListMigrationTaskUpdatesResult
This is a paginated API that returns all the migration-task states for the specified
MigrationTaskName
andProgressUpdateStream
. -
#list_migration_tasks(params = {}) ⇒ Types::ListMigrationTasksResult
Lists all, or filtered by resource name, migration tasks associated with the user account making this call.
-
#list_progress_update_streams(params = {}) ⇒ Types::ListProgressUpdateStreamsResult
Lists progress update streams associated with the user account making this call.
-
#list_source_resources(params = {}) ⇒ Types::ListSourceResourcesResult
Lists all the source resource that are associated with the specified
MigrationTaskName
andProgressUpdateStream
. -
#notify_application_state(params = {}) ⇒ Struct
Sets the migration state of an application.
-
#notify_migration_task_state(params = {}) ⇒ Struct
Notifies Migration Hub of the current status, progress, or other detail regarding a migration task.
-
#put_resource_attributes(params = {}) ⇒ Struct
Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service repository.
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.
483 484 485 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 483 def initialize(*args) super end |
Instance Method Details
#associate_created_artifact(params = {}) ⇒ Struct
Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool. This API has the following traits:
Migration tools can call the
AssociateCreatedArtifact
operation to indicate which AWS artifact is associated with a migration task.The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example:
arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b
.Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or DMS endpoint, etc.
537 538 539 540 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 537 def associate_created_artifact(params = {}, = {}) req = build_request(:associate_created_artifact, params) req.send_request() end |
#associate_discovered_resource(params = {}) ⇒ Struct
Associates a discovered resource ID from Application Discovery Service with a migration task.
577 578 579 580 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 577 def associate_discovered_resource(params = {}, = {}) req = build_request(:associate_discovered_resource, params) req.send_request() end |
#associate_source_resource(params = {}) ⇒ Struct
Associates a source resource with a migration task. For example, the source resource can be a source server, an application, or a migration wave.
626 627 628 629 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 626 def associate_source_resource(params = {}, = {}) req = build_request(:associate_source_resource, params) req.send_request() end |
#create_progress_update_stream(params = {}) ⇒ Struct
Creates a progress update stream which is an AWS resource used for access control as well as a namespace for migration task names that is implicitly linked to your AWS account. It must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account.
659 660 661 662 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 659 def create_progress_update_stream(params = {}, = {}) req = build_request(:create_progress_update_stream, params) req.send_request() end |
#delete_progress_update_stream(params = {}) ⇒ Struct
Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control. This API has the following traits:
The only parameter needed for
DeleteProgressUpdateStream
is the stream name (same as aCreateProgressUpdateStream
call).The call will return, and a background process will asynchronously delete the stream and all of its resources (tasks, associated resources, resource attributes, created artifacts).
If the stream takes time to be deleted, it might still show up on a
ListProgressUpdateStreams
call.CreateProgressUpdateStream
,ImportMigrationTask
,NotifyMigrationTaskState
, and all Associate[*] APIs related to the tasks belonging to the stream will throw "InvalidInputException" if the stream of the same name is in the process of being deleted.Once the stream and all of its resources are deleted,
CreateProgressUpdateStream
for a stream of the same name will succeed, and that stream will be an entirely new logical resource (without any resources associated with the old stream).
710 711 712 713 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 710 def delete_progress_update_stream(params = {}, = {}) req = build_request(:delete_progress_update_stream, params) req.send_request() end |
#describe_application_state(params = {}) ⇒ Types::DescribeApplicationStateResult
Gets the migration status of an application.
741 742 743 744 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 741 def describe_application_state(params = {}, = {}) req = build_request(:describe_application_state, params) req.send_request() end |
#describe_migration_task(params = {}) ⇒ Types::DescribeMigrationTaskResult
Retrieves a list of all attributes associated with a specific migration task.
783 784 785 786 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 783 def describe_migration_task(params = {}, = {}) req = build_request(:describe_migration_task, params) req.send_request() end |
#disassociate_created_artifact(params = {}) ⇒ Struct
Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated. This API has the following traits:
A migration user can call the
DisassociateCreatedArtifacts
operation to disassociate a created AWS Artifact from a migration task.The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example:
arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b
.Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or RDS instance, etc.
835 836 837 838 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 835 def disassociate_created_artifact(params = {}, = {}) req = build_request(:disassociate_created_artifact, params) req.send_request() end |
#disassociate_discovered_resource(params = {}) ⇒ Struct
Disassociate an Application Discovery Service discovered resource from a migration task.
873 874 875 876 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 873 def disassociate_discovered_resource(params = {}, = {}) req = build_request(:disassociate_discovered_resource, params) req.send_request() end |
#disassociate_source_resource(params = {}) ⇒ Struct
Removes the association between a source resource and a migration task.
917 918 919 920 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 917 def disassociate_source_resource(params = {}, = {}) req = build_request(:disassociate_source_resource, params) req.send_request() end |
#import_migration_task(params = {}) ⇒ Struct
Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool.
This API is a prerequisite to calling the NotifyMigrationTaskState
API as the migration tool must first register the migration task with
Migration Hub.
954 955 956 957 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 954 def import_migration_task(params = {}, = {}) req = build_request(:import_migration_task, params) req.send_request() end |
#list_application_states(params = {}) ⇒ Types::ListApplicationStatesResult
Lists all the migration statuses for your applications. If you use the
optional ApplicationIds
parameter, only the migration statuses for
those applications will be returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1002 1003 1004 1005 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1002 def list_application_states(params = {}, = {}) req = build_request(:list_application_states, params) req.send_request() end |
#list_created_artifacts(params = {}) ⇒ Types::ListCreatedArtifactsResult
Lists the created artifacts attached to a given migration task in an update stream. This API has the following traits:
Gets the list of the created artifacts while migration is taking place.
Shows the artifacts created by the migration tool that was associated by the
AssociateCreatedArtifact
API.Lists created artifacts in a paginated interface.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1060 1061 1062 1063 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1060 def list_created_artifacts(params = {}, = {}) req = build_request(:list_created_artifacts, params) req.send_request() end |
#list_discovered_resources(params = {}) ⇒ Types::ListDiscoveredResourcesResult
Lists discovered resources associated with the given MigrationTask
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1109 1110 1111 1112 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1109 def list_discovered_resources(params = {}, = {}) req = build_request(:list_discovered_resources, params) req.send_request() end |
#list_migration_task_updates(params = {}) ⇒ Types::ListMigrationTaskUpdatesResult
This is a paginated API that returns all the migration-task states for
the specified MigrationTaskName
and ProgressUpdateStream
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1174 1175 1176 1177 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1174 def list_migration_task_updates(params = {}, = {}) req = build_request(:list_migration_task_updates, params) req.send_request() end |
#list_migration_tasks(params = {}) ⇒ Types::ListMigrationTasksResult
Lists all, or filtered by resource name, migration tasks associated with the user account making this call. This API has the following traits:
Can show a summary list of the most recent migration tasks.
Can show a summary list of migration tasks associated with a given discovered resource.
Lists migration tasks in a paginated interface.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1231 1232 1233 1234 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1231 def list_migration_tasks(params = {}, = {}) req = build_request(:list_migration_tasks, params) req.send_request() end |
#list_progress_update_streams(params = {}) ⇒ Types::ListProgressUpdateStreamsResult
Lists progress update streams associated with the user account making this call.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1271 1272 1273 1274 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1271 def list_progress_update_streams(params = {}, = {}) req = build_request(:list_progress_update_streams, params) req.send_request() end |
#list_source_resources(params = {}) ⇒ Types::ListSourceResourcesResult
Lists all the source resource that are associated with the specified
MigrationTaskName
and ProgressUpdateStream
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1334 1335 1336 1337 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1334 def list_source_resources(params = {}, = {}) req = build_request(:list_source_resources, params) req.send_request() end |
#notify_application_state(params = {}) ⇒ Struct
Sets the migration state of an application. For a given application
identified by the value passed to ApplicationId
, its status is set
or updated by passing one of three values to Status
: NOT_STARTED |
IN_PROGRESS | COMPLETED
.
1373 1374 1375 1376 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1373 def notify_application_state(params = {}, = {}) req = build_request(:notify_application_state, params) req.send_request() end |
#notify_migration_task_state(params = {}) ⇒ Struct
Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits:
Migration tools will call the
NotifyMigrationTaskState
API to share the latest progress and status.MigrationTaskName
is used for addressing updates to the correct target.ProgressUpdateStream
is used for access control and to provide a namespace for each migration tool.
1434 1435 1436 1437 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1434 def notify_migration_task_state(params = {}, = {}) req = build_request(:notify_migration_task_state, params) req.send_request() end |
#put_resource_attributes(params = {}) ⇒ Struct
Provides identifying details of the resource being migrated so that it
can be associated in the Application Discovery Service repository.
This association occurs asynchronously after PutResourceAttributes
returns.
Keep in mind that subsequent calls to PutResourceAttributes will override previously stored attributes. For example, if it is first called with a MAC address, but later, it is desired to add an IP address, it will then be required to call it with both the IP and MAC addresses to prevent overriding the MAC address.
Note the instructions regarding the special use case of the
ResourceAttributeList
parameter when specifying any "VM" related value.
ListDiscoveredResources
.
1525 1526 1527 1528 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1525 def put_resource_attributes(params = {}, = {}) req = build_request(:put_resource_attributes, params) req.send_request() end |