You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::MigrationHub::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::MigrationHub::Client

show all

Defined in:: (unknown)

Overview

An API client for AWS Migration Hub. To construct a client, you need to configure a :region and :credentials.

migrationhub = Aws::MigrationHub::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

ENV['AWS_REGION']
Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
Aws.config[:credentials]
The shared credentials ini file at ~/.aws/credentials (more information)
From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::MigrationHub::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

#initialize(options = {}) ⇒ Aws::MigrationHub::Client constructor
Constructs an API client.

API Operations collapse

#associate_created_artifact(options = {}) ⇒ 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(options = {}) ⇒ Struct
Associates a discovered resource ID from Application Discovery Service with a migration task.

.
#create_progress_update_stream(options = {}) ⇒ 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(options = {}) ⇒ 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(options = {}) ⇒ Types::DescribeApplicationStateResult
Gets the migration status of an application.

.
#describe_migration_task(options = {}) ⇒ Types::DescribeMigrationTaskResult
Retrieves a list of all attributes associated with a specific migration task.

.
#disassociate_created_artifact(options = {}) ⇒ 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(options = {}) ⇒ Struct
Disassociate an Application Discovery Service discovered resource from a migration task.

.
#import_migration_task(options = {}) ⇒ 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.
.
#list_application_states(options = {}) ⇒ Types::ListApplicationStatesResult
Lists all the migration statuses for your applications.
#list_created_artifacts(options = {}) ⇒ Types::ListCreatedArtifactsResult
Lists the created artifacts attached to a given migration task in an update stream.
#list_discovered_resources(options = {}) ⇒ Types::ListDiscoveredResourcesResult
Lists discovered resources associated with the given MigrationTask.

.
#list_migration_tasks(options = {}) ⇒ Types::ListMigrationTasksResult
Lists all, or filtered by resource name, migration tasks associated with the user account making this call.
#list_progress_update_streams(options = {}) ⇒ Types::ListProgressUpdateStreamsResult
Lists progress update streams associated with the user account making this call.

.
#notify_application_state(options = {}) ⇒ Struct
Sets the migration state of an application.
#notify_migration_task_state(options = {}) ⇒ Struct
Notifies Migration Hub of the current status, progress, or other detail regarding a migration task.
#put_resource_attributes(options = {}) ⇒ 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

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean
Waiters polls an API operation until a resource enters a desired state.
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters.

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ `Aws::MigrationHub::Client`

Constructs an API client.

Options Hash (options):

:access_key_id (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:active_endpoint_cache (Boolean) —
When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.
:convert_params (Boolean) — default: true —
When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.
:credentials (required, Credentials) —
Your AWS credentials. The following locations will be searched in order for credentials:
- :access_key_id, :secret_access_key, and :session_token options
- ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
- HOME/.aws/credentials shared credentials file
- EC2 instance profile credentials See Plugins::RequestSigner for more details.
:disable_host_prefix_injection (Boolean) —
Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.
:endpoint (String) —
A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.
:endpoint_cache_max_entries (Integer) —
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.
:endpoint_cache_max_threads (Integer) —
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.
:endpoint_cache_poll_interval (Integer) —
When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.
:endpoint_discovery (Boolean) —
When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.
:http_continue_timeout (Float) — default: 1 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_idle_timeout (Integer) — default: 5 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_open_timeout (Integer) — default: 15 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_proxy (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_read_timeout (Integer) — default: 60 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_wire_trace (Boolean) — default: false —
See Seahorse::Client::Plugins::NetHttp for more details.
:log_level (Symbol) — default: :info —
The log level to send messages to the logger at. See Plugins::Logging for more details.
:log_formatter (Logging::LogFormatter) —
The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.
:logger (Logger) — default: nil —
The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.
:profile (String) —
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.
:raise_response_errors (Boolean) — default: true —
When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.
:region (required, String) —
The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.
:retry_limit (Integer) — default: 3 —
The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.
:secret_access_key (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:session_token (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:simple_json (Boolean) — default: false —
Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.
:ssl_ca_bundle (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_directory (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_store (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_verify_peer (Boolean) — default: true —
See Seahorse::Client::Plugins::NetHttp for more details.
:stub_responses (Boolean) — default: false —
Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.
:validate_params (Boolean) — default: true —
When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#associate_created_artifact(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.associate_created_artifact({
  progress_update_stream: "ProgressUpdateStream", # required
  migration_task_name: "MigrationTaskName", # required
  created_artifact: { # required
    name: "CreatedArtifactName", # required
    description: "CreatedArtifactDescription",
  },
  dry_run: false,
})

Options Hash (options):

:progress_update_stream (required, String) —
The name of the ProgressUpdateStream.
:migration_task_name (required, String) —
Unique identifier that references the migration task. Do not store personal data in this field.
:created_artifact (required, Types::CreatedArtifact) —
An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)
:dry_run (Boolean) —
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#associate_discovered_resource(options = {}) ⇒ `Struct`

Associates a discovered resource ID from Application Discovery Service with a migration task.

Examples:

Request syntax with placeholder values


resp = client.associate_discovered_resource({
  progress_update_stream: "ProgressUpdateStream", # required
  migration_task_name: "MigrationTaskName", # required
  discovered_resource: { # required
    configuration_id: "ConfigurationId", # required
    description: "DiscoveredResourceDescription",
  },
  dry_run: false,
})

Options Hash (options):

:progress_update_stream (required, String) —
The name of the ProgressUpdateStream.
:migration_task_name (required, String) —
The identifier given to the MigrationTask. Do not store personal data in this field.
:discovered_resource (required, Types::DiscoveredResource) —
Object representing a Resource.
:dry_run (Boolean) —
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#create_progress_update_stream(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.create_progress_update_stream({
  progress_update_stream_name: "ProgressUpdateStream", # required
  dry_run: false,
})

Options Hash (options):

:progress_update_stream_name (required, String) —
The name of the ProgressUpdateStream. Do not store personal data in this field.
:dry_run (Boolean) —
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#delete_progress_update_stream(options = {}) ⇒ `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 a CreateProgressUpdateStream 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).

Examples:

Request syntax with placeholder values


resp = client.delete_progress_update_stream({
  progress_update_stream_name: "ProgressUpdateStream", # required
  dry_run: false,
})

Options Hash (options):

:progress_update_stream_name (required, String) —
The name of the ProgressUpdateStream. Do not store personal data in this field.
:dry_run (Boolean) —
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#describe_application_state(options = {}) ⇒ `Types::DescribeApplicationStateResult`

Gets the migration status of an application.

Examples:

Request syntax with placeholder values


resp = client.describe_application_state({
  application_id: "ApplicationId", # required
})

Response structure


resp.application_status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED"
resp.last_updated_time #=> Time

Options Hash (options):

:application_id (required, String) —
The configurationId in Application Discovery Service that uniquely identifies the grouped application.

Returns:

(Types::DescribeApplicationStateResult) —
Returns a response object which responds to the following methods:
- #application_status => String
- #last_updated_time => Time

See Also:

AWS API Documentation

#describe_migration_task(options = {}) ⇒ `Types::DescribeMigrationTaskResult`

Retrieves a list of all attributes associated with a specific migration task.

Examples:

Request syntax with placeholder values


resp = client.describe_migration_task({
  progress_update_stream: "ProgressUpdateStream", # required
  migration_task_name: "MigrationTaskName", # required
})

Response structure


resp.migration_task.progress_update_stream #=> String
resp.migration_task.migration_task_name #=> String
resp.migration_task.task.status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "FAILED", "COMPLETED"
resp.migration_task.task.status_detail #=> String
resp.migration_task.task.progress_percent #=> Integer
resp.migration_task.update_date_time #=> Time
resp.migration_task.resource_attribute_list #=> Array
resp.migration_task.resource_attribute_list[0].type #=> String, one of "IPV4_ADDRESS", "IPV6_ADDRESS", "MAC_ADDRESS", "FQDN", "VM_MANAGER_ID", "VM_MANAGED_OBJECT_REFERENCE", "VM_NAME", "VM_PATH", "BIOS_ID", "MOTHERBOARD_SERIAL_NUMBER"
resp.migration_task.resource_attribute_list[0].value #=> String

Options Hash (options):

:progress_update_stream (required, String) —
The name of the ProgressUpdateStream.
:migration_task_name (required, String) —
The identifier given to the MigrationTask. Do not store personal data in this field.

Returns:

(Types::DescribeMigrationTaskResult) —
Returns a response object which responds to the following methods:
- #migration_task => Types::MigrationTask

See Also:

AWS API Documentation

#disassociate_created_artifact(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.disassociate_created_artifact({
  progress_update_stream: "ProgressUpdateStream", # required
  migration_task_name: "MigrationTaskName", # required
  created_artifact_name: "CreatedArtifactName", # required
  dry_run: false,
})

Options Hash (options):

:progress_update_stream (required, String) —
The name of the ProgressUpdateStream.
:migration_task_name (required, String) —
Unique identifier that references the migration task to be disassociated with the artifact. Do not store personal data in this field.
:created_artifact_name (required, String) —
An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)
:dry_run (Boolean) —
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#disassociate_discovered_resource(options = {}) ⇒ `Struct`

Disassociate an Application Discovery Service discovered resource from a migration task.

Examples:

Request syntax with placeholder values


resp = client.disassociate_discovered_resource({
  progress_update_stream: "ProgressUpdateStream", # required
  migration_task_name: "MigrationTaskName", # required
  configuration_id: "ConfigurationId", # required
  dry_run: false,
})

Options Hash (options):

:progress_update_stream (required, String) —
The name of the ProgressUpdateStream.
:migration_task_name (required, String) —
The identifier given to the MigrationTask. Do not store personal data in this field.
:configuration_id (required, String) —
ConfigurationId of the Application Discovery Service resource to be disassociated.
:dry_run (Boolean) —
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#import_migration_task(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.import_migration_task({
  progress_update_stream: "ProgressUpdateStream", # required
  migration_task_name: "MigrationTaskName", # required
  dry_run: false,
})

Options Hash (options):

:progress_update_stream (required, String) —
The name of the ProgressUpdateStream. >
:migration_task_name (required, String) —
Unique identifier that references the migration task. Do not store personal data in this field.
:dry_run (Boolean) —
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#list_application_states(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.list_application_states({
  application_ids: ["ApplicationId"],
  next_token: "Token",
  max_results: 1,
})

Response structure


resp.application_state_list #=> Array
resp.application_state_list[0].application_id #=> String
resp.application_state_list[0].application_status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED"
resp.application_state_list[0].last_updated_time #=> Time
resp.next_token #=> String

Options Hash (options):

:application_ids (Array<String>) —
The configurationIds from the Application Discovery Service that uniquely identifies your applications.
:next_token (String) —
If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.
:max_results (Integer) —
Maximum number of results to be returned per page.

Returns:

(Types::ListApplicationStatesResult) —
Returns a response object which responds to the following methods:
- #application_state_list => Array<Types::ApplicationState>
- #next_token => String

See Also:

AWS API Documentation

#list_created_artifacts(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.list_created_artifacts({
  progress_update_stream: "ProgressUpdateStream", # required
  migration_task_name: "MigrationTaskName", # required
  next_token: "Token",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.created_artifact_list #=> Array
resp.created_artifact_list[0].name #=> String
resp.created_artifact_list[0].description #=> String

Options Hash (options):

:progress_update_stream (required, String) —
The name of the ProgressUpdateStream.
:migration_task_name (required, String) —
Unique identifier that references the migration task. Do not store personal data in this field.
:next_token (String) —
If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.
:max_results (Integer) —
Maximum number of results to be returned per page.

Returns:

(Types::ListCreatedArtifactsResult) —
Returns a response object which responds to the following methods:
- #next_token => String
- #created_artifact_list => Array<Types::CreatedArtifact>

See Also:

AWS API Documentation

#list_discovered_resources(options = {}) ⇒ `Types::ListDiscoveredResourcesResult`

Lists discovered resources associated with the given MigrationTask.

Examples:

Request syntax with placeholder values


resp = client.list_discovered_resources({
  progress_update_stream: "ProgressUpdateStream", # required
  migration_task_name: "MigrationTaskName", # required
  next_token: "Token",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.discovered_resource_list #=> Array
resp.discovered_resource_list[0].configuration_id #=> String
resp.discovered_resource_list[0].description #=> String

Options Hash (options):

:progress_update_stream (required, String) —
The name of the ProgressUpdateStream.
:migration_task_name (required, String) —
The name of the MigrationTask. Do not store personal data in this field.
:next_token (String) —
If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.
:max_results (Integer) —
The maximum number of results returned per page.

Returns:

(Types::ListDiscoveredResourcesResult) —
Returns a response object which responds to the following methods:
- #next_token => String
- #discovered_resource_list => Array<Types::DiscoveredResource>

See Also:

AWS API Documentation

#list_migration_tasks(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.list_migration_tasks({
  next_token: "Token",
  max_results: 1,
  resource_name: "ResourceName",
})

Response structure


resp.next_token #=> String
resp.migration_task_summary_list #=> Array
resp.migration_task_summary_list[0].progress_update_stream #=> String
resp.migration_task_summary_list[0].migration_task_name #=> String
resp.migration_task_summary_list[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "FAILED", "COMPLETED"
resp.migration_task_summary_list[0].progress_percent #=> Integer
resp.migration_task_summary_list[0].status_detail #=> String
resp.migration_task_summary_list[0].update_date_time #=> Time

Options Hash (options):

:next_token (String) —
If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.
:max_results (Integer) —
Value to specify how many results are returned per page.
:resource_name (String) —
Filter migration tasks by discovered resource name.

Returns:

(Types::ListMigrationTasksResult) —
Returns a response object which responds to the following methods:
- #next_token => String
- #migration_task_summary_list => Array<Types::MigrationTaskSummary>

See Also:

AWS API Documentation

#list_progress_update_streams(options = {}) ⇒ `Types::ListProgressUpdateStreamsResult`

Lists progress update streams associated with the user account making this call.

Examples:

Request syntax with placeholder values


resp = client.list_progress_update_streams({
  next_token: "Token",
  max_results: 1,
})

Response structure


resp.progress_update_stream_summary_list #=> Array
resp.progress_update_stream_summary_list[0].progress_update_stream_name #=> String
resp.next_token #=> String

Options Hash (options):

:next_token (String) —
If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.
:max_results (Integer) —
Filter to limit the maximum number of results to list per page.

Returns:

(Types::ListProgressUpdateStreamsResult) —
Returns a response object which responds to the following methods:
- #progress_update_stream_summary_list => Array<Types::ProgressUpdateStreamSummary>
- #next_token => String

See Also:

AWS API Documentation

#notify_application_state(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.notify_application_state({
  application_id: "ApplicationId", # required
  status: "NOT_STARTED", # required, accepts NOT_STARTED, IN_PROGRESS, COMPLETED
  update_date_time: Time.now,
  dry_run: false,
})

Options Hash (options):

:application_id (required, String) —
The configurationId in Application Discovery Service that uniquely identifies the grouped application.
:status (required, String) —
Status of the application - Not Started, In-Progress, Complete.
:update_date_time (Time) —
The timestamp when the application state changed.
:dry_run (Boolean) —
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#notify_migration_task_state(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.notify_migration_task_state({
  progress_update_stream: "ProgressUpdateStream", # required
  migration_task_name: "MigrationTaskName", # required
  task: { # required
    status: "NOT_STARTED", # required, accepts NOT_STARTED, IN_PROGRESS, FAILED, COMPLETED
    status_detail: "StatusDetail",
    progress_percent: 1,
  },
  update_date_time: Time.now, # required
  next_update_seconds: 1, # required
  dry_run: false,
})

Options Hash (options):

:progress_update_stream (required, String) —
The name of the ProgressUpdateStream.
:migration_task_name (required, String) —
Unique identifier that references the migration task. Do not store personal data in this field.
:task (required, Types::Task) —
Information about the task\'s progress and status.
:update_date_time (required, Time) —
The timestamp when the task was gathered.
:next_update_seconds (required, Integer) —
Number of seconds after the UpdateDateTime within which the Migration Hub can expect an update. If Migration Hub does not receive an update within the specified interval, then the migration task will be considered stale.
:dry_run (Boolean) —
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#put_resource_attributes(options = {}) ⇒ `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.

Because this is an asynchronous call, it will always return 200, whether an association occurs or not. To confirm if an association was found based on the provided details, call ListDiscoveredResources.

Examples:

Request syntax with placeholder values


resp = client.put_resource_attributes({
  progress_update_stream: "ProgressUpdateStream", # required
  migration_task_name: "MigrationTaskName", # required
  resource_attribute_list: [ # required
    {
      type: "IPV4_ADDRESS", # required, accepts IPV4_ADDRESS, IPV6_ADDRESS, MAC_ADDRESS, FQDN, VM_MANAGER_ID, VM_MANAGED_OBJECT_REFERENCE, VM_NAME, VM_PATH, BIOS_ID, MOTHERBOARD_SERIAL_NUMBER
      value: "ResourceAttributeValue", # required
    },
  ],
  dry_run: false,
})

Options Hash (options):

:progress_update_stream (required, String) —
The name of the ProgressUpdateStream.
:migration_task_name (required, String) —
Unique identifier that references the migration task. Do not store personal data in this field.
:resource_attribute_list (required, Array<Types::ResourceAttribute>) —
Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service repository.

Takes the object array of ResourceAttribute where the Type field is reserved for the following values: IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER where the identifying value can be a string up to 256 characters.

* If any \"VM\" related value is set for a ResourceAttribute object, it is required that VM_MANAGER_ID, as a minimum, is always set. If VM_MANAGER_ID is not set, then all \"VM\" fields will be discarded and \"VM\" fields will not be used for matching the migration task to a server in Application Discovery Service repository. See the Example section below for a use case of specifying \"VM\" related values.
- If a server you are trying to match has multiple IP or MAC addresses, you should provide as many as you know in separate type/value pairs passed to the ResourceAttributeList parameter to maximize the chances of matching.
:dry_run (Boolean) —
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ `Boolean`

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

waiter_name (Symbol) —
The name of the waiter. See #waiter_names for a full list of supported waiters.
params (Hash) (defaults to: {}) —
Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

waiter (Waiters::Waiter) —
Yields a Waiter object that can be configured prior to waiting.

Returns:

(Boolean) —
Returns true if the waiter was successful.

Raises:

(Errors::FailureStateError) —
Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.
(Errors::TooManyAttemptsError) —
Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.
(Errors::UnexpectedError) —
Raised when an error is encounted while polling for a resource that is not expected.
(Errors::NoSuchWaiterError) —
Raised when you request to wait for an unknown state.

#waiter_names ⇒ `Array<Symbol>`

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter Name	Client Method	Default Delay:	Default Max Attempts:

Returns:

(Array<Symbol>) —
the list of supported waiters.

Class: Aws::MigrationHub::Client

Overview

Region

Credentials

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

#initialize(options = {}) ⇒ Aws::MigrationHub::Client

Instance Method Details

#associate_created_artifact(options = {}) ⇒ Struct

#associate_discovered_resource(options = {}) ⇒ Struct

#create_progress_update_stream(options = {}) ⇒ Struct

#delete_progress_update_stream(options = {}) ⇒ Struct

#describe_application_state(options = {}) ⇒ Types::DescribeApplicationStateResult

#describe_migration_task(options = {}) ⇒ Types::DescribeMigrationTaskResult

#disassociate_created_artifact(options = {}) ⇒ Struct

#disassociate_discovered_resource(options = {}) ⇒ Struct

#import_migration_task(options = {}) ⇒ Struct

#list_application_states(options = {}) ⇒ Types::ListApplicationStatesResult

#list_created_artifacts(options = {}) ⇒ Types::ListCreatedArtifactsResult

#list_discovered_resources(options = {}) ⇒ Types::ListDiscoveredResourcesResult

#list_migration_tasks(options = {}) ⇒ Types::ListMigrationTasksResult

#list_progress_update_streams(options = {}) ⇒ Types::ListProgressUpdateStreamsResult

#notify_application_state(options = {}) ⇒ Struct

#notify_migration_task_state(options = {}) ⇒ Struct

#put_resource_attributes(options = {}) ⇒ Struct

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Basic Usage

Configuration

Callbacks

Handling Errors

#waiter_names ⇒ Array<Symbol>

#initialize(options = {}) ⇒ `Aws::MigrationHub::Client`

#associate_created_artifact(options = {}) ⇒ `Struct`

#associate_discovered_resource(options = {}) ⇒ `Struct`

#create_progress_update_stream(options = {}) ⇒ `Struct`

#delete_progress_update_stream(options = {}) ⇒ `Struct`

#describe_application_state(options = {}) ⇒ `Types::DescribeApplicationStateResult`

#describe_migration_task(options = {}) ⇒ `Types::DescribeMigrationTaskResult`

#disassociate_created_artifact(options = {}) ⇒ `Struct`

#disassociate_discovered_resource(options = {}) ⇒ `Struct`

#import_migration_task(options = {}) ⇒ `Struct`

#list_application_states(options = {}) ⇒ `Types::ListApplicationStatesResult`

#list_created_artifacts(options = {}) ⇒ `Types::ListCreatedArtifactsResult`

#list_discovered_resources(options = {}) ⇒ `Types::ListDiscoveredResourcesResult`

#list_migration_tasks(options = {}) ⇒ `Types::ListMigrationTasksResult`

#list_progress_update_streams(options = {}) ⇒ `Types::ListProgressUpdateStreamsResult`

#notify_application_state(options = {}) ⇒ `Struct`

#notify_migration_task_state(options = {}) ⇒ `Struct`

#put_resource_attributes(options = {}) ⇒ `Struct`

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ `Boolean`

#waiter_names ⇒ `Array<Symbol>`