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.
-
#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.
-
#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_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.
-
#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.
447 448 449 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 447 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.
501 502 503 504 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 501 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.
541 542 543 544 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 541 def associate_discovered_resource(params = {}, = {}) req = build_request(:associate_discovered_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.
574 575 576 577 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 574 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).
625 626 627 628 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 625 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.
656 657 658 659 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 656 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.
698 699 700 701 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 698 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.
750 751 752 753 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 750 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.
788 789 790 791 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 788 def disassociate_discovered_resource(params = {}, = {}) req = build_request(:disassociate_discovered_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.
825 826 827 828 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 825 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.
873 874 875 876 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 873 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.
931 932 933 934 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 931 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.
980 981 982 983 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 980 def list_discovered_resources(params = {}, = {}) req = build_request(:list_discovered_resources, 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.
1037 1038 1039 1040 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1037 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.
1077 1078 1079 1080 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1077 def list_progress_update_streams(params = {}, = {}) req = build_request(:list_progress_update_streams, 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
.
1116 1117 1118 1119 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1116 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.
1177 1178 1179 1180 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1177 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
.
1268 1269 1270 1271 |
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1268 def put_resource_attributes(params = {}, = {}) req = build_request(:put_resource_attributes, params) req.send_request() end |