Class: Aws::MigrationHub::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    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.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.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.

  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::MigrationHub::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::MigrationHub::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



451
452
453
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 451

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.

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,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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:



505
506
507
508
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 505

def associate_created_artifact(params = {}, options = {})
  req = build_request(:associate_created_artifact, params)
  req.send_request(options)
end

#associate_discovered_resource(params = {}) ⇒ 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,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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:



545
546
547
548
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 545

def associate_discovered_resource(params = {}, options = {})
  req = build_request(:associate_discovered_resource, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.associate_source_resource({
  progress_update_stream: "ProgressUpdateStream", # required
  migration_task_name: "MigrationTaskName", # required
  source_resource: { # required
    name: "SourceResourceName", # required
    description: "SourceResourceDescription",
    status_detail: "StatusDetail",
  },
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :progress_update_stream (required, String) —

    The name of the progress-update stream, which is used for access control as well as a namespace for migration-task names that is implicitly linked to your AWS account. The progress-update stream 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.

  • :migration_task_name (required, String) —

    A unique identifier that references the migration task. Do not include sensitive data in this field.

  • :source_resource (required, Types::SourceResource) —

    The source resource that you want to associate.

  • :dry_run (Boolean) —

    This is an optional parameter that you can use to test whether the call will succeed. Set this parameter to true to verify that you have the permissions that are required to make the call, and that you have specified the other parameters in the call correctly.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



594
595
596
597
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 594

def associate_source_resource(params = {}, options = {})
  req = build_request(:associate_source_resource, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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:



627
628
629
630
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 627

def create_progress_update_stream(params = {}, options = {})
  req = build_request(:create_progress_update_stream, params)
  req.send_request(options)
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 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,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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:



678
679
680
681
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 678

def delete_progress_update_stream(params = {}, options = {})
  req = build_request(:delete_progress_update_stream, params)
  req.send_request(options)
end

#describe_application_state(params = {}) ⇒ 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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The configurationId in Application Discovery Service that uniquely identifies the grouped application.

Returns:

See Also:



709
710
711
712
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 709

def describe_application_state(params = {}, options = {})
  req = build_request(:describe_application_state, params)
  req.send_request(options)
end

#describe_migration_task(params = {}) ⇒ 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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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:

See Also:



751
752
753
754
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 751

def describe_migration_task(params = {}, options = {})
  req = build_request(:describe_migration_task, params)
  req.send_request(options)
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.

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,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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:



803
804
805
806
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 803

def disassociate_created_artifact(params = {}, options = {})
  req = build_request(:disassociate_created_artifact, params)
  req.send_request(options)
end

#disassociate_discovered_resource(params = {}) ⇒ 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,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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:



841
842
843
844
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 841

def disassociate_discovered_resource(params = {}, options = {})
  req = build_request(:disassociate_discovered_resource, params)
  req.send_request(options)
end

#disassociate_source_resource(params = {}) ⇒ Struct

Removes the association between a source resource and a migration task.

Examples:

Request syntax with placeholder values


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :progress_update_stream (required, String) —

    The name of the progress-update stream, which is used for access control as well as a namespace for migration-task names that is implicitly linked to your AWS account. The progress-update stream 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.

  • :migration_task_name (required, String) —

    A unique identifier that references the migration task. Do not include sensitive data in this field.

  • :source_resource_name (required, String) —

    The name that was specified for the source resource.

  • :dry_run (Boolean) —

    This is an optional parameter that you can use to test whether the call will succeed. Set this parameter to true to verify that you have the permissions that are required to make the call, and that you have specified the other parameters in the call correctly.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



885
886
887
888
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 885

def disassociate_source_resource(params = {}, options = {})
  req = build_request(:disassociate_source_resource, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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:



922
923
924
925
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 922

def import_migration_task(params = {}, options = {})
  req = build_request(:import_migration_task, params)
  req.send_request(options)
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.

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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:

See Also:



970
971
972
973
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 970

def list_application_states(params = {}, options = {})
  req = build_request(:list_application_states, params)
  req.send_request(options)
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.

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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:

See Also:



1028
1029
1030
1031
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1028

def list_created_artifacts(params = {}, options = {})
  req = build_request(:list_created_artifacts, params)
  req.send_request(options)
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.

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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:

See Also:



1077
1078
1079
1080
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1077

def list_discovered_resources(params = {}, options = {})
  req = build_request(:list_discovered_resources, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


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

Response structure


resp.next_token #=> String
resp.migration_task_update_list #=> Array
resp.migration_task_update_list[0].update_date_time #=> Time
resp.migration_task_update_list[0].update_type #=> String, one of "MIGRATION_TASK_STATE_UPDATED"
resp.migration_task_update_list[0].migration_task_state.status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "FAILED", "COMPLETED"
resp.migration_task_update_list[0].migration_task_state.status_detail #=> String
resp.migration_task_update_list[0].migration_task_state.progress_percent #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :progress_update_stream (required, String) —

    The name of the progress-update stream, which is used for access control as well as a namespace for migration-task names that is implicitly linked to your AWS account. The progress-update stream 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.

  • :migration_task_name (required, String) —

    A unique identifier that references the migration task. Do not include sensitive data in this field.

  • :next_token (String) —

    If NextToken was returned by a previous call, there are more results available. The value of NextToken is a unique pagination token for each page. To retrieve the next page of results, specify the NextToken value that the previous call returned. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • :max_results (Integer) —

    The maximum number of results to include in the response. If more results exist than the value that you specify here for MaxResults, the response will include a token that you can use to retrieve the next set of results.

Returns:

See Also:



1142
1143
1144
1145
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1142

def list_migration_task_updates(params = {}, options = {})
  req = build_request(:list_migration_task_updates, params)
  req.send_request(options)
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.

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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:

See Also:



1199
1200
1201
1202
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1199

def list_migration_tasks(params = {}, options = {})
  req = build_request(:list_migration_tasks, params)
  req.send_request(options)
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.

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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:

See Also:



1239
1240
1241
1242
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1239

def list_progress_update_streams(params = {}, options = {})
  req = build_request(:list_progress_update_streams, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :progress_update_stream (required, String) —

    The name of the progress-update stream, which is used for access control as well as a namespace for migration-task names that is implicitly linked to your AWS account. The progress-update stream 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.

  • :migration_task_name (required, String) —

    A unique identifier that references the migration task. Do not store confidential data in this field.

  • :next_token (String) —

    If NextToken was returned by a previous call, there are more results available. The value of NextToken is a unique pagination token for each page. To retrieve the next page of results, specify the NextToken value that the previous call returned. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • :max_results (Integer) —

    The maximum number of results to include in the response. If more results exist than the value that you specify here for MaxResults, the response will include a token that you can use to retrieve the next set of results.

Returns:

See Also:



1302
1303
1304
1305
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1302

def list_source_resources(params = {}, options = {})
  req = build_request(:list_source_resources, params)
  req.send_request(options)
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.

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,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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, DateTime, Date, Integer, String) —

    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:



1341
1342
1343
1344
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1341

def notify_application_state(params = {}, options = {})
  req = build_request(:notify_application_state, params)
  req.send_request(options)
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.

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,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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, DateTime, Date, Integer, String) —

    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:



1402
1403
1404
1405
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1402

def notify_migration_task_state(params = {}, options = {})
  req = build_request(:notify_migration_task_state, params)
  req.send_request(options)
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.

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,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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:



1493
1494
1495
1496
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/client.rb', line 1493

def put_resource_attributes(params = {}, options = {})
  req = build_request(:put_resource_attributes, params)
  req.send_request(options)
end