Class: Aws::Mgn::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb

Overview

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

client = Aws::Mgn::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 used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or 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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

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

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :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_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :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.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :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
  • :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) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or 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::Mgn::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Mgn::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.



473
474
475
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 473

def initialize(*args)
  super
end

Instance Method Details

#archive_application(params = {}) ⇒ Types::Application

Archive application.

Examples:

Request syntax with placeholder values


resp = client.archive_application({
  account_id: "AccountID",
  application_id: "ApplicationID", # required
})

Response structure


resp.application_aggregated_status.health_status #=> String, one of "HEALTHY", "LAGGING", "ERROR"
resp.application_aggregated_status.last_update_date_time #=> String
resp.application_aggregated_status.progress_status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED"
resp.application_aggregated_status.total_source_servers #=> Integer
resp.application_id #=> String
resp.arn #=> String
resp.creation_date_time #=> String
resp.description #=> String
resp.is_archived #=> Boolean
resp.last_modified_date_time #=> String
resp.name #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.wave_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Account ID.

  • :application_id (required, String) —

    Application ID.

Returns:

See Also:



528
529
530
531
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 528

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

#archive_wave(params = {}) ⇒ Types::Wave

Archive wave.

Examples:

Request syntax with placeholder values


resp = client.archive_wave({
  account_id: "AccountID",
  wave_id: "WaveID", # required
})

Response structure


resp.arn #=> String
resp.creation_date_time #=> String
resp.description #=> String
resp.is_archived #=> Boolean
resp.last_modified_date_time #=> String
resp.name #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.wave_aggregated_status.health_status #=> String, one of "HEALTHY", "LAGGING", "ERROR"
resp.wave_aggregated_status.last_update_date_time #=> String
resp.wave_aggregated_status.progress_status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED"
resp.wave_aggregated_status.replication_started_date_time #=> String
resp.wave_aggregated_status.total_applications #=> Integer
resp.wave_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Account ID.

  • :wave_id (required, String) —

    Wave ID.

Returns:

See Also:



581
582
583
584
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 581

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

#associate_applications(params = {}) ⇒ Struct

Associate applications to wave.

Examples:

Request syntax with placeholder values


resp = client.associate_applications({
  account_id: "AccountID",
  application_i_ds: ["ApplicationID"], # required
  wave_id: "WaveID", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Account ID.

  • :application_i_ds (required, Array<String>) —

    Application IDs list.

  • :wave_id (required, String) —

    Wave ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



611
612
613
614
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 611

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

#associate_source_servers(params = {}) ⇒ Struct

Associate source servers to application.

Examples:

Request syntax with placeholder values


resp = client.associate_source_servers({
  account_id: "AccountID",
  application_id: "ApplicationID", # required
  source_server_i_ds: ["SourceServerID"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Account ID.

  • :application_id (required, String) —

    Application ID.

  • :source_server_i_ds (required, Array<String>) —

    Source server IDs list.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



641
642
643
644
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 641

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

#change_server_life_cycle_state(params = {}) ⇒ Types::SourceServer

Allows the user to set the SourceServer.LifeCycle.state property for specific Source Server IDs to one of the following: READY_FOR_TEST or READY_FOR_CUTOVER. This command only works if the Source Server is already launchable (dataReplicationInfo.lagDuration is not null.)

Examples:

Request syntax with placeholder values


resp = client.change_server_life_cycle_state({
  account_id: "AccountID",
  life_cycle: { # required
    state: "READY_FOR_TEST", # required, accepts READY_FOR_TEST, READY_FOR_CUTOVER, CUTOVER
  },
  source_server_id: "SourceServerID", # required
})

Response structure


resp.application_id #=> String
resp.arn #=> String
resp.connector_action.connector_arn #=> String
resp.connector_action.credentials_secret_arn #=> String
resp.data_replication_info.data_replication_error.error #=> String, one of "AGENT_NOT_SEEN", "SNAPSHOTS_FAILURE", "NOT_CONVERGING", "UNSTABLE_NETWORK", "FAILED_TO_CREATE_SECURITY_GROUP", "FAILED_TO_LAUNCH_REPLICATION_SERVER", "FAILED_TO_BOOT_REPLICATION_SERVER", "FAILED_TO_AUTHENTICATE_WITH_SERVICE", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", "FAILED_TO_CREATE_STAGING_DISKS", "FAILED_TO_ATTACH_STAGING_DISKS", "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", "FAILED_TO_START_DATA_TRANSFER", "UNSUPPORTED_VM_CONFIGURATION", "LAST_SNAPSHOT_JOB_FAILED"
resp.data_replication_info.data_replication_error.raw_error #=> String
resp.data_replication_info.data_replication_initiation.next_attempt_date_time #=> String
resp.data_replication_info.data_replication_initiation.start_date_time #=> String
resp.data_replication_info.data_replication_initiation.steps #=> Array
resp.data_replication_info.data_replication_initiation.steps[0].name #=> String, one of "WAIT", "CREATE_SECURITY_GROUP", "LAUNCH_REPLICATION_SERVER", "BOOT_REPLICATION_SERVER", "AUTHENTICATE_WITH_SERVICE", "DOWNLOAD_REPLICATION_SOFTWARE", "CREATE_STAGING_DISKS", "ATTACH_STAGING_DISKS", "PAIR_REPLICATION_SERVER_WITH_AGENT", "CONNECT_AGENT_TO_REPLICATION_SERVER", "START_DATA_TRANSFER"
resp.data_replication_info.data_replication_initiation.steps[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "SKIPPED"
resp.data_replication_info.data_replication_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED", "PENDING_SNAPSHOT_SHIPPING", "SHIPPING_SNAPSHOT"
resp.data_replication_info.eta_date_time #=> String
resp.data_replication_info.lag_duration #=> String
resp.data_replication_info.last_snapshot_date_time #=> String
resp.data_replication_info.replicated_disks #=> Array
resp.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].device_name #=> String
resp.data_replication_info.replicated_disks[0].replicated_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].rescanned_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].total_storage_bytes #=> Integer
resp.fqdn_for_action_framework #=> String
resp.is_archived #=> Boolean
resp.launched_instance.ec2_instance_id #=> String
resp.launched_instance.first_boot #=> String, one of "WAITING", "SUCCEEDED", "UNKNOWN", "STOPPED"
resp.launched_instance.job_id #=> String
resp.life_cycle.added_to_service_date_time #=> String
resp.life_cycle.elapsed_replication_duration #=> String
resp.life_cycle.first_byte_date_time #=> String
resp.life_cycle.last_cutover.finalized.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.job_id #=> String
resp.life_cycle.last_cutover.reverted.api_call_date_time #=> String
resp.life_cycle.last_seen_by_service_date_time #=> String
resp.life_cycle.last_test.finalized.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.job_id #=> String
resp.life_cycle.last_test.reverted.api_call_date_time #=> String
resp.life_cycle.state #=> String, one of "STOPPED", "NOT_READY", "READY_FOR_TEST", "TESTING", "READY_FOR_CUTOVER", "CUTTING_OVER", "CUTOVER", "DISCONNECTED", "DISCOVERED", "PENDING_INSTALLATION"
resp.replication_type #=> String, one of "AGENT_BASED", "SNAPSHOT_SHIPPING"
resp.source_properties.cpus #=> Array
resp.source_properties.cpus[0].cores #=> Integer
resp.source_properties.cpus[0].model_name #=> String
resp.source_properties.disks #=> Array
resp.source_properties.disks[0].bytes #=> Integer
resp.source_properties.disks[0].device_name #=> String
resp.source_properties.identification_hints.aws_instance_id #=> String
resp.source_properties.identification_hints.fqdn #=> String
resp.source_properties.identification_hints.hostname #=> String
resp.source_properties.identification_hints.vm_path #=> String
resp.source_properties.identification_hints.vm_ware_uuid #=> String
resp.source_properties.last_updated_date_time #=> String
resp.source_properties.network_interfaces #=> Array
resp.source_properties.network_interfaces[0].ips #=> Array
resp.source_properties.network_interfaces[0].ips[0] #=> String
resp.source_properties.network_interfaces[0].is_primary #=> Boolean
resp.source_properties.network_interfaces[0].mac_address #=> String
resp.source_properties.os.full_string #=> String
resp.source_properties.ram_bytes #=> Integer
resp.source_properties.recommended_instance_type #=> String
resp.source_server_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.user_provided_id #=> String
resp.vcenter_client_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The request to change the source server migration account ID.

  • :life_cycle (required, Types::ChangeServerLifeCycleStateSourceServerLifecycle) —

    The request to change the source server migration lifecycle state.

  • :source_server_id (required, String) —

    The request to change the source server migration lifecycle state by source server ID.

Returns:

See Also:



760
761
762
763
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 760

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

#create_application(params = {}) ⇒ Types::Application

Create application.

Examples:

Request syntax with placeholder values


resp = client.create_application({
  account_id: "AccountID",
  description: "ApplicationDescription",
  name: "ApplicationName", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.application_aggregated_status.health_status #=> String, one of "HEALTHY", "LAGGING", "ERROR"
resp.application_aggregated_status.last_update_date_time #=> String
resp.application_aggregated_status.progress_status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED"
resp.application_aggregated_status.total_source_servers #=> Integer
resp.application_id #=> String
resp.arn #=> String
resp.creation_date_time #=> String
resp.description #=> String
resp.is_archived #=> Boolean
resp.last_modified_date_time #=> String
resp.name #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.wave_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Account ID.

  • :description (String) —

    Application description.

  • :name (required, String) —

    Application name.

  • :tags (Hash<String,String>) —

    Application tags.

Returns:

See Also:



824
825
826
827
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 824

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

#create_connector(params = {}) ⇒ Types::Connector

Create Connector.

Examples:

Request syntax with placeholder values


resp = client.create_connector({
  name: "ConnectorName", # required
  ssm_command_config: {
    cloud_watch_log_group_name: "CloudWatchLogGroupName",
    cloud_watch_output_enabled: false, # required
    output_s3_bucket_name: "S3BucketName",
    s3_output_enabled: false, # required
  },
  ssm_instance_id: "SsmInstanceID", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.connector_id #=> String
resp.name #=> String
resp.ssm_command_config.cloud_watch_log_group_name #=> String
resp.ssm_command_config.cloud_watch_output_enabled #=> Boolean
resp.ssm_command_config.output_s3_bucket_name #=> String
resp.ssm_command_config.s3_output_enabled #=> Boolean
resp.ssm_instance_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    Create Connector request name.

  • :ssm_command_config (Types::ConnectorSsmCommandConfig) —

    Create Connector request SSM command config.

  • :ssm_instance_id (required, String) —

    Create Connector request SSM instance ID.

  • :tags (Hash<String,String>) —

    Create Connector request tags.

Returns:

See Also:



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

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

#create_launch_configuration_template(params = {}) ⇒ Types::LaunchConfigurationTemplate

Creates a new Launch Configuration Template.

Examples:

Request syntax with placeholder values


resp = client.create_launch_configuration_template({
  associate_public_ip_address: false,
  boot_mode: "LEGACY_BIOS", # accepts LEGACY_BIOS, UEFI, USE_SOURCE
  copy_private_ip: false,
  copy_tags: false,
  enable_map_auto_tagging: false,
  large_volume_conf: {
    iops: 1,
    throughput: 1,
    volume_type: "io1", # accepts io1, io2, gp3, gp2, st1, sc1, standard
  },
  launch_disposition: "STOPPED", # accepts STOPPED, STARTED
  licensing: {
    os_byol: false,
  },
  map_auto_tagging_mpe_id: "TagValue",
  post_launch_actions: {
    cloud_watch_log_group_name: "CloudWatchLogGroupName",
    deployment: "TEST_AND_CUTOVER", # accepts TEST_AND_CUTOVER, CUTOVER_ONLY, TEST_ONLY
    s3_log_bucket: "S3LogBucketName",
    s3_output_key_prefix: "BoundedString",
    ssm_documents: [
      {
        action_name: "BoundedString", # required
        external_parameters: {
          "SsmDocumentParameterName" => {
            dynamic_path: "JmesPathString",
          },
        },
        must_succeed_for_cutover: false,
        parameters: {
          "SsmDocumentParameterName" => [
            {
              parameter_name: "SsmParameterStoreParameterName", # required
              parameter_type: "STRING", # required, accepts STRING
            },
          ],
        },
        ssm_document_name: "SsmDocumentName", # required
        timeout_seconds: 1,
      },
    ],
  },
  small_volume_conf: {
    iops: 1,
    throughput: 1,
    volume_type: "io1", # accepts io1, io2, gp3, gp2, st1, sc1, standard
  },
  small_volume_max_size: 1,
  tags: {
    "TagKey" => "TagValue",
  },
  target_instance_type_right_sizing_method: "NONE", # accepts NONE, BASIC
})

Response structure


resp.arn #=> String
resp.associate_public_ip_address #=> Boolean
resp.boot_mode #=> String, one of "LEGACY_BIOS", "UEFI", "USE_SOURCE"
resp.copy_private_ip #=> Boolean
resp.copy_tags #=> Boolean
resp.ec2_launch_template_id #=> String
resp.enable_map_auto_tagging #=> Boolean
resp.large_volume_conf.iops #=> Integer
resp.large_volume_conf.throughput #=> Integer
resp.large_volume_conf.volume_type #=> String, one of "io1", "io2", "gp3", "gp2", "st1", "sc1", "standard"
resp.launch_configuration_template_id #=> String
resp.launch_disposition #=> String, one of "STOPPED", "STARTED"
resp.licensing.os_byol #=> Boolean
resp.map_auto_tagging_mpe_id #=> String
resp.post_launch_actions.cloud_watch_log_group_name #=> String
resp.post_launch_actions.deployment #=> String, one of "TEST_AND_CUTOVER", "CUTOVER_ONLY", "TEST_ONLY"
resp.post_launch_actions.s3_log_bucket #=> String
resp.post_launch_actions.s3_output_key_prefix #=> String
resp.post_launch_actions.ssm_documents #=> Array
resp.post_launch_actions.ssm_documents[0].action_name #=> String
resp.post_launch_actions.ssm_documents[0].external_parameters #=> Hash
resp.post_launch_actions.ssm_documents[0].external_parameters["SsmDocumentParameterName"].dynamic_path #=> String
resp.post_launch_actions.ssm_documents[0].must_succeed_for_cutover #=> Boolean
resp.post_launch_actions.ssm_documents[0].parameters #=> Hash
resp.post_launch_actions.ssm_documents[0].parameters["SsmDocumentParameterName"] #=> Array
resp.post_launch_actions.ssm_documents[0].parameters["SsmDocumentParameterName"][0].parameter_name #=> String
resp.post_launch_actions.ssm_documents[0].parameters["SsmDocumentParameterName"][0].parameter_type #=> String, one of "STRING"
resp.post_launch_actions.ssm_documents[0].ssm_document_name #=> String
resp.post_launch_actions.ssm_documents[0].timeout_seconds #=> Integer
resp.small_volume_conf.iops #=> Integer
resp.small_volume_conf.throughput #=> Integer
resp.small_volume_conf.volume_type #=> String, one of "io1", "io2", "gp3", "gp2", "st1", "sc1", "standard"
resp.small_volume_max_size #=> Integer
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.target_instance_type_right_sizing_method #=> String, one of "NONE", "BASIC"

Parameters:

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

    ({})

Options Hash (params):

  • :associate_public_ip_address (Boolean) —

    Associate public Ip address.

  • :boot_mode (String) —

    Launch configuration template boot mode.

  • :copy_private_ip (Boolean) —

    Copy private Ip.

  • :copy_tags (Boolean) —

    Copy tags.

  • :enable_map_auto_tagging (Boolean) —

    Enable map auto tagging.

  • :large_volume_conf (Types::LaunchTemplateDiskConf) —

    Large volume config.

  • :launch_disposition (String) —

    Launch disposition.

  • :licensing (Types::Licensing) —

    Configure Licensing.

  • :map_auto_tagging_mpe_id (String) —

    Launch configuration template map auto tagging MPE ID.

  • :post_launch_actions (Types::PostLaunchActions) —

    Launch configuration template post launch actions.

  • :small_volume_conf (Types::LaunchTemplateDiskConf) —

    Small volume config.

  • :small_volume_max_size (Integer) —

    Small volume maximum size.

  • :tags (Hash<String,String>) —

    Request to associate tags during creation of a Launch Configuration Template.

  • :target_instance_type_right_sizing_method (String) —

    Target instance type right-sizing method.

Returns:

See Also:



1055
1056
1057
1058
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1055

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

#create_replication_configuration_template(params = {}) ⇒ Types::ReplicationConfigurationTemplate

Creates a new ReplicationConfigurationTemplate.

Examples:

Request syntax with placeholder values


resp = client.create_replication_configuration_template({
  associate_default_security_group: false, # required
  bandwidth_throttling: 1, # required
  create_public_ip: false, # required
  data_plane_routing: "PRIVATE_IP", # required, accepts PRIVATE_IP, PUBLIC_IP
  default_large_staging_disk_type: "GP2", # required, accepts GP2, ST1, GP3
  ebs_encryption: "DEFAULT", # required, accepts DEFAULT, CUSTOM
  ebs_encryption_key_arn: "ARN",
  replication_server_instance_type: "EC2InstanceType", # required
  replication_servers_security_groups_i_ds: ["SecurityGroupID"], # required
  staging_area_subnet_id: "SubnetID", # required
  staging_area_tags: { # required
    "TagKey" => "TagValue",
  },
  tags: {
    "TagKey" => "TagValue",
  },
  use_dedicated_replication_server: false, # required
  use_fips_endpoint: false,
})

Response structure


resp.arn #=> String
resp.associate_default_security_group #=> Boolean
resp.bandwidth_throttling #=> Integer
resp.create_public_ip #=> Boolean
resp.data_plane_routing #=> String, one of "PRIVATE_IP", "PUBLIC_IP"
resp.default_large_staging_disk_type #=> String, one of "GP2", "ST1", "GP3"
resp.ebs_encryption #=> String, one of "DEFAULT", "CUSTOM"
resp.ebs_encryption_key_arn #=> String
resp.replication_configuration_template_id #=> String
resp.replication_server_instance_type #=> String
resp.replication_servers_security_groups_i_ds #=> Array
resp.replication_servers_security_groups_i_ds[0] #=> String
resp.staging_area_subnet_id #=> String
resp.staging_area_tags #=> Hash
resp.staging_area_tags["TagKey"] #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.use_dedicated_replication_server #=> Boolean
resp.use_fips_endpoint #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :associate_default_security_group (required, Boolean) —

    Request to associate the default Application Migration Service Security group with the Replication Settings template.

  • :bandwidth_throttling (required, Integer) —

    Request to configure bandwidth throttling during Replication Settings template creation.

  • :create_public_ip (required, Boolean) —

    Request to create Public IP during Replication Settings template creation.

  • :data_plane_routing (required, String) —

    Request to configure data plane routing during Replication Settings template creation.

  • :default_large_staging_disk_type (required, String) —

    Request to configure the default large staging disk EBS volume type during Replication Settings template creation.

  • :ebs_encryption (required, String) —

    Request to configure EBS encryption during Replication Settings template creation.

  • :ebs_encryption_key_arn (String) —

    Request to configure an EBS encryption key during Replication Settings template creation.

  • :replication_server_instance_type (required, String) —

    Request to configure the Replication Server instance type during Replication Settings template creation.

  • :replication_servers_security_groups_i_ds (required, Array<String>) —

    Request to configure the Replication Server Security group ID during Replication Settings template creation.

  • :staging_area_subnet_id (required, String) —

    Request to configure the Staging Area subnet ID during Replication Settings template creation.

  • :staging_area_tags (required, Hash<String,String>) —

    Request to configure Staging Area tags during Replication Settings template creation.

  • :tags (Hash<String,String>) —

    Request to configure tags during Replication Settings template creation.

  • :use_dedicated_replication_server (required, Boolean) —

    Request to use Dedicated Replication Servers during Replication Settings template creation.

  • :use_fips_endpoint (Boolean) —

    Request to use Fips Endpoint during Replication Settings template creation.

Returns:

See Also:



1186
1187
1188
1189
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1186

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

#create_wave(params = {}) ⇒ Types::Wave

Create wave.

Examples:

Request syntax with placeholder values


resp = client.create_wave({
  account_id: "AccountID",
  description: "WaveDescription",
  name: "WaveName", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.creation_date_time #=> String
resp.description #=> String
resp.is_archived #=> Boolean
resp.last_modified_date_time #=> String
resp.name #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.wave_aggregated_status.health_status #=> String, one of "HEALTHY", "LAGGING", "ERROR"
resp.wave_aggregated_status.last_update_date_time #=> String
resp.wave_aggregated_status.progress_status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED"
resp.wave_aggregated_status.replication_started_date_time #=> String
resp.wave_aggregated_status.total_applications #=> Integer
resp.wave_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Account ID.

  • :description (String) —

    Wave description.

  • :name (required, String) —

    Wave name.

  • :tags (Hash<String,String>) —

    Wave tags.

Returns:

See Also:



1249
1250
1251
1252
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1249

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

#delete_application(params = {}) ⇒ Struct

Delete application.

Examples:

Request syntax with placeholder values


resp = client.delete_application({
  account_id: "AccountID",
  application_id: "ApplicationID", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Account ID.

  • :application_id (required, String) —

    Application ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1275
1276
1277
1278
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1275

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

#delete_connector(params = {}) ⇒ Struct

Delete Connector.

Examples:

Request syntax with placeholder values


resp = client.delete_connector({
  connector_id: "ConnectorID", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :connector_id (required, String) —

    Delete Connector request connector ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1297
1298
1299
1300
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1297

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

#delete_job(params = {}) ⇒ Struct

Deletes a single Job by ID.

Examples:

Request syntax with placeholder values


resp = client.delete_job({
  account_id: "AccountID",
  job_id: "JobID", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Request to delete Job from service by Account ID.

  • :job_id (required, String) —

    Request to delete Job from service by Job ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1323
1324
1325
1326
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1323

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

#delete_launch_configuration_template(params = {}) ⇒ Struct

Deletes a single Launch Configuration Template by ID.

Examples:

Request syntax with placeholder values


resp = client.delete_launch_configuration_template({
  launch_configuration_template_id: "LaunchConfigurationTemplateID", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :launch_configuration_template_id (required, String) —

    ID of resource to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1345
1346
1347
1348
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1345

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

#delete_replication_configuration_template(params = {}) ⇒ Struct

Deletes a single Replication Configuration Template by ID

Examples:

Request syntax with placeholder values


resp = client.delete_replication_configuration_template({
  replication_configuration_template_id: "ReplicationConfigurationTemplateID", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :replication_configuration_template_id (required, String) —

    Request to delete Replication Configuration Template from service by Replication Configuration Template ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1368
1369
1370
1371
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1368

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

#delete_source_server(params = {}) ⇒ Struct

Deletes a single source server by ID.

Examples:

Request syntax with placeholder values


resp = client.delete_source_server({
  account_id: "AccountID",
  source_server_id: "SourceServerID", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Request to delete Source Server from service by Account ID.

  • :source_server_id (required, String) —

    Request to delete Source Server from service by Server ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1394
1395
1396
1397
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1394

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

#delete_vcenter_client(params = {}) ⇒ Struct

Deletes a given vCenter client by ID.

Examples:

Request syntax with placeholder values


resp = client.delete_vcenter_client({
  vcenter_client_id: "VcenterClientID", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :vcenter_client_id (required, String) —

    ID of resource to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1416
1417
1418
1419
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1416

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

#delete_wave(params = {}) ⇒ Struct

Delete wave.

Examples:

Request syntax with placeholder values


resp = client.delete_wave({
  account_id: "AccountID",
  wave_id: "WaveID", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Account ID.

  • :wave_id (required, String) —

    Wave ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1442
1443
1444
1445
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1442

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

#describe_job_log_items(params = {}) ⇒ Types::DescribeJobLogItemsResponse

Retrieves detailed job log items with paging.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_job_log_items({
  account_id: "AccountID",
  job_id: "JobID", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].event #=> String, one of "JOB_START", "SERVER_SKIPPED", "CLEANUP_START", "CLEANUP_END", "CLEANUP_FAIL", "SNAPSHOT_START", "SNAPSHOT_END", "SNAPSHOT_FAIL", "USING_PREVIOUS_SNAPSHOT", "CONVERSION_START", "CONVERSION_END", "CONVERSION_FAIL", "LAUNCH_START", "LAUNCH_FAILED", "JOB_CANCEL", "JOB_END"
resp.items[0].event_data.conversion_server_id #=> String
resp.items[0].event_data.raw_error #=> String
resp.items[0].event_data.source_server_id #=> String
resp.items[0].event_data.target_instance_id #=> String
resp.items[0].log_date_time #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Request to describe Job log Account ID.

  • :job_id (required, String) —

    Request to describe Job log job ID.

  • :max_results (Integer) —

    Request to describe Job log item maximum results.

  • :next_token (String) —

    Request to describe Job log next token.

Returns:

See Also:



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

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

#describe_jobs(params = {}) ⇒ Types::DescribeJobsResponse

Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normally created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to Support and only used in response to relevant support tickets.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_jobs({
  account_id: "AccountID",
  filters: {
    from_date: "ISO8601DatetimeString",
    job_i_ds: ["JobID"],
    to_date: "ISO8601DatetimeString",
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].creation_date_time #=> String
resp.items[0].end_date_time #=> String
resp.items[0].initiated_by #=> String, one of "START_TEST", "START_CUTOVER", "DIAGNOSTIC", "TERMINATE"
resp.items[0].job_id #=> String
resp.items[0].participating_servers #=> Array
resp.items[0].participating_servers[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.items[0].participating_servers[0].launched_ec2_instance_id #=> String
resp.items[0].participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list #=> Array
resp.items[0].participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].execution_id #=> String
resp.items[0].participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].execution_status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
resp.items[0].participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].failure_reason #=> String
resp.items[0].participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.action_name #=> String
resp.items[0].participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.external_parameters #=> Hash
resp.items[0].participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.external_parameters["SsmDocumentParameterName"].dynamic_path #=> String
resp.items[0].participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.must_succeed_for_cutover #=> Boolean
resp.items[0].participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.parameters #=> Hash
resp.items[0].participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.parameters["SsmDocumentParameterName"] #=> Array
resp.items[0].participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.parameters["SsmDocumentParameterName"][0].parameter_name #=> String
resp.items[0].participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.parameters["SsmDocumentParameterName"][0].parameter_type #=> String, one of "STRING"
resp.items[0].participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.ssm_document_name #=> String
resp.items[0].participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.timeout_seconds #=> Integer
resp.items[0].participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document_type #=> String, one of "AUTOMATION", "COMMAND"
resp.items[0].participating_servers[0].post_launch_actions_status.ssm_agent_discovery_datetime #=> String
resp.items[0].participating_servers[0].source_server_id #=> String
resp.items[0].status #=> String, one of "PENDING", "STARTED", "COMPLETED"
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.items[0].type #=> String, one of "LAUNCH", "TERMINATE"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Request to describe job log items by Account ID.

  • :filters (Types::DescribeJobsRequestFilters) —

    Request to describe Job log filters.

  • :max_results (Integer) —

    Request to describe job log items by max results.

  • :next_token (String) —

    Request to describe job log items by next token.

Returns:

See Also:



1575
1576
1577
1578
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1575

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

#describe_launch_configuration_templates(params = {}) ⇒ Types::DescribeLaunchConfigurationTemplatesResponse

Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_launch_configuration_templates({
  launch_configuration_template_i_ds: ["LaunchConfigurationTemplateID"],
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].associate_public_ip_address #=> Boolean
resp.items[0].boot_mode #=> String, one of "LEGACY_BIOS", "UEFI", "USE_SOURCE"
resp.items[0].copy_private_ip #=> Boolean
resp.items[0].copy_tags #=> Boolean
resp.items[0].ec2_launch_template_id #=> String
resp.items[0].enable_map_auto_tagging #=> Boolean
resp.items[0].large_volume_conf.iops #=> Integer
resp.items[0].large_volume_conf.throughput #=> Integer
resp.items[0].large_volume_conf.volume_type #=> String, one of "io1", "io2", "gp3", "gp2", "st1", "sc1", "standard"
resp.items[0].launch_configuration_template_id #=> String
resp.items[0].launch_disposition #=> String, one of "STOPPED", "STARTED"
resp.items[0].licensing.os_byol #=> Boolean
resp.items[0].map_auto_tagging_mpe_id #=> String
resp.items[0].post_launch_actions.cloud_watch_log_group_name #=> String
resp.items[0].post_launch_actions.deployment #=> String, one of "TEST_AND_CUTOVER", "CUTOVER_ONLY", "TEST_ONLY"
resp.items[0].post_launch_actions.s3_log_bucket #=> String
resp.items[0].post_launch_actions.s3_output_key_prefix #=> String
resp.items[0].post_launch_actions.ssm_documents #=> Array
resp.items[0].post_launch_actions.ssm_documents[0].action_name #=> String
resp.items[0].post_launch_actions.ssm_documents[0].external_parameters #=> Hash
resp.items[0].post_launch_actions.ssm_documents[0].external_parameters["SsmDocumentParameterName"].dynamic_path #=> String
resp.items[0].post_launch_actions.ssm_documents[0].must_succeed_for_cutover #=> Boolean
resp.items[0].post_launch_actions.ssm_documents[0].parameters #=> Hash
resp.items[0].post_launch_actions.ssm_documents[0].parameters["SsmDocumentParameterName"] #=> Array
resp.items[0].post_launch_actions.ssm_documents[0].parameters["SsmDocumentParameterName"][0].parameter_name #=> String
resp.items[0].post_launch_actions.ssm_documents[0].parameters["SsmDocumentParameterName"][0].parameter_type #=> String, one of "STRING"
resp.items[0].post_launch_actions.ssm_documents[0].ssm_document_name #=> String
resp.items[0].post_launch_actions.ssm_documents[0].timeout_seconds #=> Integer
resp.items[0].small_volume_conf.iops #=> Integer
resp.items[0].small_volume_conf.throughput #=> Integer
resp.items[0].small_volume_conf.volume_type #=> String, one of "io1", "io2", "gp3", "gp2", "st1", "sc1", "standard"
resp.items[0].small_volume_max_size #=> Integer
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.items[0].target_instance_type_right_sizing_method #=> String, one of "NONE", "BASIC"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :launch_configuration_template_i_ds (Array<String>) —

    Request to filter Launch Configuration Templates list by Launch Configuration Template ID.

  • :max_results (Integer) —

    Maximum results to be returned in DescribeLaunchConfigurationTemplates.

  • :next_token (String) —

    Next pagination token returned from DescribeLaunchConfigurationTemplates.

Returns:

See Also:



1655
1656
1657
1658
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1655

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

#describe_replication_configuration_templates(params = {}) ⇒ Types::DescribeReplicationConfigurationTemplatesResponse

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_replication_configuration_templates({
  max_results: 1,
  next_token: "PaginationToken",
  replication_configuration_template_i_ds: ["ReplicationConfigurationTemplateID"],
})

Response structure


resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].associate_default_security_group #=> Boolean
resp.items[0].bandwidth_throttling #=> Integer
resp.items[0].create_public_ip #=> Boolean
resp.items[0].data_plane_routing #=> String, one of "PRIVATE_IP", "PUBLIC_IP"
resp.items[0].default_large_staging_disk_type #=> String, one of "GP2", "ST1", "GP3"
resp.items[0].ebs_encryption #=> String, one of "DEFAULT", "CUSTOM"
resp.items[0].ebs_encryption_key_arn #=> String
resp.items[0].replication_configuration_template_id #=> String
resp.items[0].replication_server_instance_type #=> String
resp.items[0].replication_servers_security_groups_i_ds #=> Array
resp.items[0].replication_servers_security_groups_i_ds[0] #=> String
resp.items[0].staging_area_subnet_id #=> String
resp.items[0].staging_area_tags #=> Hash
resp.items[0].staging_area_tags["TagKey"] #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.items[0].use_dedicated_replication_server #=> Boolean
resp.items[0].use_fips_endpoint #=> Boolean
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Request to describe Replication Configuration template by max results.

  • :next_token (String) —

    Request to describe Replication Configuration template by next token.

  • :replication_configuration_template_i_ds (Array<String>) —

    Request to describe Replication Configuration template by template IDs.

Returns:

See Also:



1716
1717
1718
1719
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1716

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

#describe_source_servers(params = {}) ⇒ Types::DescribeSourceServersResponse

Retrieves all SourceServers or multiple SourceServers by ID.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_source_servers({
  account_id: "AccountID",
  filters: {
    application_i_ds: ["ApplicationID"],
    is_archived: false,
    life_cycle_states: ["STOPPED"], # accepts STOPPED, NOT_READY, READY_FOR_TEST, TESTING, READY_FOR_CUTOVER, CUTTING_OVER, CUTOVER, DISCONNECTED, DISCOVERED, PENDING_INSTALLATION
    replication_types: ["AGENT_BASED"], # accepts AGENT_BASED, SNAPSHOT_SHIPPING
    source_server_i_ds: ["SourceServerID"],
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].application_id #=> String
resp.items[0].arn #=> String
resp.items[0].connector_action.connector_arn #=> String
resp.items[0].connector_action.credentials_secret_arn #=> String
resp.items[0].data_replication_info.data_replication_error.error #=> String, one of "AGENT_NOT_SEEN", "SNAPSHOTS_FAILURE", "NOT_CONVERGING", "UNSTABLE_NETWORK", "FAILED_TO_CREATE_SECURITY_GROUP", "FAILED_TO_LAUNCH_REPLICATION_SERVER", "FAILED_TO_BOOT_REPLICATION_SERVER", "FAILED_TO_AUTHENTICATE_WITH_SERVICE", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", "FAILED_TO_CREATE_STAGING_DISKS", "FAILED_TO_ATTACH_STAGING_DISKS", "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", "FAILED_TO_START_DATA_TRANSFER", "UNSUPPORTED_VM_CONFIGURATION", "LAST_SNAPSHOT_JOB_FAILED"
resp.items[0].data_replication_info.data_replication_error.raw_error #=> String
resp.items[0].data_replication_info.data_replication_initiation.next_attempt_date_time #=> String
resp.items[0].data_replication_info.data_replication_initiation.start_date_time #=> String
resp.items[0].data_replication_info.data_replication_initiation.steps #=> Array
resp.items[0].data_replication_info.data_replication_initiation.steps[0].name #=> String, one of "WAIT", "CREATE_SECURITY_GROUP", "LAUNCH_REPLICATION_SERVER", "BOOT_REPLICATION_SERVER", "AUTHENTICATE_WITH_SERVICE", "DOWNLOAD_REPLICATION_SOFTWARE", "CREATE_STAGING_DISKS", "ATTACH_STAGING_DISKS", "PAIR_REPLICATION_SERVER_WITH_AGENT", "CONNECT_AGENT_TO_REPLICATION_SERVER", "START_DATA_TRANSFER"
resp.items[0].data_replication_info.data_replication_initiation.steps[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "SKIPPED"
resp.items[0].data_replication_info.data_replication_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED", "PENDING_SNAPSHOT_SHIPPING", "SHIPPING_SNAPSHOT"
resp.items[0].data_replication_info.eta_date_time #=> String
resp.items[0].data_replication_info.lag_duration #=> String
resp.items[0].data_replication_info.last_snapshot_date_time #=> String
resp.items[0].data_replication_info.replicated_disks #=> Array
resp.items[0].data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.items[0].data_replication_info.replicated_disks[0].device_name #=> String
resp.items[0].data_replication_info.replicated_disks[0].replicated_storage_bytes #=> Integer
resp.items[0].data_replication_info.replicated_disks[0].rescanned_storage_bytes #=> Integer
resp.items[0].data_replication_info.replicated_disks[0].total_storage_bytes #=> Integer
resp.items[0].fqdn_for_action_framework #=> String
resp.items[0].is_archived #=> Boolean
resp.items[0].launched_instance.ec2_instance_id #=> String
resp.items[0].launched_instance.first_boot #=> String, one of "WAITING", "SUCCEEDED", "UNKNOWN", "STOPPED"
resp.items[0].launched_instance.job_id #=> String
resp.items[0].life_cycle.added_to_service_date_time #=> String
resp.items[0].life_cycle.elapsed_replication_duration #=> String
resp.items[0].life_cycle.first_byte_date_time #=> String
resp.items[0].life_cycle.last_cutover.finalized.api_call_date_time #=> String
resp.items[0].life_cycle.last_cutover.initiated.api_call_date_time #=> String
resp.items[0].life_cycle.last_cutover.initiated.job_id #=> String
resp.items[0].life_cycle.last_cutover.reverted.api_call_date_time #=> String
resp.items[0].life_cycle.last_seen_by_service_date_time #=> String
resp.items[0].life_cycle.last_test.finalized.api_call_date_time #=> String
resp.items[0].life_cycle.last_test.initiated.api_call_date_time #=> String
resp.items[0].life_cycle.last_test.initiated.job_id #=> String
resp.items[0].life_cycle.last_test.reverted.api_call_date_time #=> String
resp.items[0].life_cycle.state #=> String, one of "STOPPED", "NOT_READY", "READY_FOR_TEST", "TESTING", "READY_FOR_CUTOVER", "CUTTING_OVER", "CUTOVER", "DISCONNECTED", "DISCOVERED", "PENDING_INSTALLATION"
resp.items[0].replication_type #=> String, one of "AGENT_BASED", "SNAPSHOT_SHIPPING"
resp.items[0].source_properties.cpus #=> Array
resp.items[0].source_properties.cpus[0].cores #=> Integer
resp.items[0].source_properties.cpus[0].model_name #=> String
resp.items[0].source_properties.disks #=> Array
resp.items[0].source_properties.disks[0].bytes #=> Integer
resp.items[0].source_properties.disks[0].device_name #=> String
resp.items[0].source_properties.identification_hints.aws_instance_id #=> String
resp.items[0].source_properties.identification_hints.fqdn #=> String
resp.items[0].source_properties.identification_hints.hostname #=> String
resp.items[0].source_properties.identification_hints.vm_path #=> String
resp.items[0].source_properties.identification_hints.vm_ware_uuid #=> String
resp.items[0].source_properties.last_updated_date_time #=> String
resp.items[0].source_properties.network_interfaces #=> Array
resp.items[0].source_properties.network_interfaces[0].ips #=> Array
resp.items[0].source_properties.network_interfaces[0].ips[0] #=> String
resp.items[0].source_properties.network_interfaces[0].is_primary #=> Boolean
resp.items[0].source_properties.network_interfaces[0].mac_address #=> String
resp.items[0].source_properties.os.full_string #=> String
resp.items[0].source_properties.ram_bytes #=> Integer
resp.items[0].source_properties.recommended_instance_type #=> String
resp.items[0].source_server_id #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.items[0].user_provided_id #=> String
resp.items[0].vcenter_client_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Request to filter Source Servers list by Accoun ID.

  • :filters (Types::DescribeSourceServersRequestFilters) —

    Request to filter Source Servers list.

  • :max_results (Integer) —

    Request to filter Source Servers list by maximum results.

  • :next_token (String) —

    Request to filter Source Servers list by next token.

Returns:

See Also:



1831
1832
1833
1834
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1831

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

#describe_vcenter_clients(params = {}) ⇒ Types::DescribeVcenterClientsResponse

Returns a list of the installed vCenter clients.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_vcenter_clients({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].datacenter_name #=> String
resp.items[0].hostname #=> String
resp.items[0].last_seen_datetime #=> String
resp.items[0].source_server_tags #=> Hash
resp.items[0].source_server_tags["TagKey"] #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.items[0].vcenter_client_id #=> String
resp.items[0].vcenter_uuid #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Maximum results to be returned in DescribeVcenterClients.

  • :next_token (String) —

    Next pagination token to be provided for DescribeVcenterClients.

Returns:

See Also:



1877
1878
1879
1880
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1877

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

#disassociate_applications(params = {}) ⇒ Struct

Disassociate applications from wave.

Examples:

Request syntax with placeholder values


resp = client.disassociate_applications({
  account_id: "AccountID",
  application_i_ds: ["ApplicationID"], # required
  wave_id: "WaveID", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Account ID.

  • :application_i_ds (required, Array<String>) —

    Application IDs list.

  • :wave_id (required, String) —

    Wave ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1907
1908
1909
1910
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1907

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

#disassociate_source_servers(params = {}) ⇒ Struct

Disassociate source servers from application.

Examples:

Request syntax with placeholder values


resp = client.disassociate_source_servers({
  account_id: "AccountID",
  application_id: "ApplicationID", # required
  source_server_i_ds: ["SourceServerID"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Account ID.

  • :application_id (required, String) —

    Application ID.

  • :source_server_i_ds (required, Array<String>) —

    Source server IDs list.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1937
1938
1939
1940
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1937

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

#disconnect_from_service(params = {}) ⇒ Types::SourceServer

Disconnects specific Source Servers from Application Migration Service. Data replication is stopped immediately. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. If the agent on the source server has not been prevented from communicating with the Application Migration Service service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

Examples:

Request syntax with placeholder values


resp = client.disconnect_from_service({
  account_id: "AccountID",
  source_server_id: "SourceServerID", # required
})

Response structure


resp.application_id #=> String
resp.arn #=> String
resp.connector_action.connector_arn #=> String
resp.connector_action.credentials_secret_arn #=> String
resp.data_replication_info.data_replication_error.error #=> String, one of "AGENT_NOT_SEEN", "SNAPSHOTS_FAILURE", "NOT_CONVERGING", "UNSTABLE_NETWORK", "FAILED_TO_CREATE_SECURITY_GROUP", "FAILED_TO_LAUNCH_REPLICATION_SERVER", "FAILED_TO_BOOT_REPLICATION_SERVER", "FAILED_TO_AUTHENTICATE_WITH_SERVICE", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", "FAILED_TO_CREATE_STAGING_DISKS", "FAILED_TO_ATTACH_STAGING_DISKS", "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", "FAILED_TO_START_DATA_TRANSFER", "UNSUPPORTED_VM_CONFIGURATION", "LAST_SNAPSHOT_JOB_FAILED"
resp.data_replication_info.data_replication_error.raw_error #=> String
resp.data_replication_info.data_replication_initiation.next_attempt_date_time #=> String
resp.data_replication_info.data_replication_initiation.start_date_time #=> String
resp.data_replication_info.data_replication_initiation.steps #=> Array
resp.data_replication_info.data_replication_initiation.steps[0].name #=> String, one of "WAIT", "CREATE_SECURITY_GROUP", "LAUNCH_REPLICATION_SERVER", "BOOT_REPLICATION_SERVER", "AUTHENTICATE_WITH_SERVICE", "DOWNLOAD_REPLICATION_SOFTWARE", "CREATE_STAGING_DISKS", "ATTACH_STAGING_DISKS", "PAIR_REPLICATION_SERVER_WITH_AGENT", "CONNECT_AGENT_TO_REPLICATION_SERVER", "START_DATA_TRANSFER"
resp.data_replication_info.data_replication_initiation.steps[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "SKIPPED"
resp.data_replication_info.data_replication_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED", "PENDING_SNAPSHOT_SHIPPING", "SHIPPING_SNAPSHOT"
resp.data_replication_info.eta_date_time #=> String
resp.data_replication_info.lag_duration #=> String
resp.data_replication_info.last_snapshot_date_time #=> String
resp.data_replication_info.replicated_disks #=> Array
resp.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].device_name #=> String
resp.data_replication_info.replicated_disks[0].replicated_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].rescanned_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].total_storage_bytes #=> Integer
resp.fqdn_for_action_framework #=> String
resp.is_archived #=> Boolean
resp.launched_instance.ec2_instance_id #=> String
resp.launched_instance.first_boot #=> String, one of "WAITING", "SUCCEEDED", "UNKNOWN", "STOPPED"
resp.launched_instance.job_id #=> String
resp.life_cycle.added_to_service_date_time #=> String
resp.life_cycle.elapsed_replication_duration #=> String
resp.life_cycle.first_byte_date_time #=> String
resp.life_cycle.last_cutover.finalized.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.job_id #=> String
resp.life_cycle.last_cutover.reverted.api_call_date_time #=> String
resp.life_cycle.last_seen_by_service_date_time #=> String
resp.life_cycle.last_test.finalized.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.job_id #=> String
resp.life_cycle.last_test.reverted.api_call_date_time #=> String
resp.life_cycle.state #=> String, one of "STOPPED", "NOT_READY", "READY_FOR_TEST", "TESTING", "READY_FOR_CUTOVER", "CUTTING_OVER", "CUTOVER", "DISCONNECTED", "DISCOVERED", "PENDING_INSTALLATION"
resp.replication_type #=> String, one of "AGENT_BASED", "SNAPSHOT_SHIPPING"
resp.source_properties.cpus #=> Array
resp.source_properties.cpus[0].cores #=> Integer
resp.source_properties.cpus[0].model_name #=> String
resp.source_properties.disks #=> Array
resp.source_properties.disks[0].bytes #=> Integer
resp.source_properties.disks[0].device_name #=> String
resp.source_properties.identification_hints.aws_instance_id #=> String
resp.source_properties.identification_hints.fqdn #=> String
resp.source_properties.identification_hints.hostname #=> String
resp.source_properties.identification_hints.vm_path #=> String
resp.source_properties.identification_hints.vm_ware_uuid #=> String
resp.source_properties.last_updated_date_time #=> String
resp.source_properties.network_interfaces #=> Array
resp.source_properties.network_interfaces[0].ips #=> Array
resp.source_properties.network_interfaces[0].ips[0] #=> String
resp.source_properties.network_interfaces[0].is_primary #=> Boolean
resp.source_properties.network_interfaces[0].mac_address #=> String
resp.source_properties.os.full_string #=> String
resp.source_properties.ram_bytes #=> Integer
resp.source_properties.recommended_instance_type #=> String
resp.source_server_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.user_provided_id #=> String
resp.vcenter_client_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Request to disconnect Source Server from service by Account ID.

  • :source_server_id (required, String) —

    Request to disconnect Source Server from service by Server ID.

Returns:

See Also:



2059
2060
2061
2062
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 2059

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

#finalize_cutover(params = {}) ⇒ Types::SourceServer

Finalizes the cutover immediately for specific Source Servers. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. The AWS Replication Agent will receive a command to uninstall itself (within 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be changed to DISCONNECTED; The SourceServer.lifeCycle.state will be changed to CUTOVER; The totalStorageBytes property fo each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

Examples:

Request syntax with placeholder values


resp = client.finalize_cutover({
  account_id: "AccountID",
  source_server_id: "SourceServerID", # required
})

Response structure


resp.application_id #=> String
resp.arn #=> String
resp.connector_action.connector_arn #=> String
resp.connector_action.credentials_secret_arn #=> String
resp.data_replication_info.data_replication_error.error #=> String, one of "AGENT_NOT_SEEN", "SNAPSHOTS_FAILURE", "NOT_CONVERGING", "UNSTABLE_NETWORK", "FAILED_TO_CREATE_SECURITY_GROUP", "FAILED_TO_LAUNCH_REPLICATION_SERVER", "FAILED_TO_BOOT_REPLICATION_SERVER", "FAILED_TO_AUTHENTICATE_WITH_SERVICE", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", "FAILED_TO_CREATE_STAGING_DISKS", "FAILED_TO_ATTACH_STAGING_DISKS", "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", "FAILED_TO_START_DATA_TRANSFER", "UNSUPPORTED_VM_CONFIGURATION", "LAST_SNAPSHOT_JOB_FAILED"
resp.data_replication_info.data_replication_error.raw_error #=> String
resp.data_replication_info.data_replication_initiation.next_attempt_date_time #=> String
resp.data_replication_info.data_replication_initiation.start_date_time #=> String
resp.data_replication_info.data_replication_initiation.steps #=> Array
resp.data_replication_info.data_replication_initiation.steps[0].name #=> String, one of "WAIT", "CREATE_SECURITY_GROUP", "LAUNCH_REPLICATION_SERVER", "BOOT_REPLICATION_SERVER", "AUTHENTICATE_WITH_SERVICE", "DOWNLOAD_REPLICATION_SOFTWARE", "CREATE_STAGING_DISKS", "ATTACH_STAGING_DISKS", "PAIR_REPLICATION_SERVER_WITH_AGENT", "CONNECT_AGENT_TO_REPLICATION_SERVER", "START_DATA_TRANSFER"
resp.data_replication_info.data_replication_initiation.steps[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "SKIPPED"
resp.data_replication_info.data_replication_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED", "PENDING_SNAPSHOT_SHIPPING", "SHIPPING_SNAPSHOT"
resp.data_replication_info.eta_date_time #=> String
resp.data_replication_info.lag_duration #=> String
resp.data_replication_info.last_snapshot_date_time #=> String
resp.data_replication_info.replicated_disks #=> Array
resp.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].device_name #=> String
resp.data_replication_info.replicated_disks[0].replicated_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].rescanned_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].total_storage_bytes #=> Integer
resp.fqdn_for_action_framework #=> String
resp.is_archived #=> Boolean
resp.launched_instance.ec2_instance_id #=> String
resp.launched_instance.first_boot #=> String, one of "WAITING", "SUCCEEDED", "UNKNOWN", "STOPPED"
resp.launched_instance.job_id #=> String
resp.life_cycle.added_to_service_date_time #=> String
resp.life_cycle.elapsed_replication_duration #=> String
resp.life_cycle.first_byte_date_time #=> String
resp.life_cycle.last_cutover.finalized.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.job_id #=> String
resp.life_cycle.last_cutover.reverted.api_call_date_time #=> String
resp.life_cycle.last_seen_by_service_date_time #=> String
resp.life_cycle.last_test.finalized.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.job_id #=> String
resp.life_cycle.last_test.reverted.api_call_date_time #=> String
resp.life_cycle.state #=> String, one of "STOPPED", "NOT_READY", "READY_FOR_TEST", "TESTING", "READY_FOR_CUTOVER", "CUTTING_OVER", "CUTOVER", "DISCONNECTED", "DISCOVERED", "PENDING_INSTALLATION"
resp.replication_type #=> String, one of "AGENT_BASED", "SNAPSHOT_SHIPPING"
resp.source_properties.cpus #=> Array
resp.source_properties.cpus[0].cores #=> Integer
resp.source_properties.cpus[0].model_name #=> String
resp.source_properties.disks #=> Array
resp.source_properties.disks[0].bytes #=> Integer
resp.source_properties.disks[0].device_name #=> String
resp.source_properties.identification_hints.aws_instance_id #=> String
resp.source_properties.identification_hints.fqdn #=> String
resp.source_properties.identification_hints.hostname #=> String
resp.source_properties.identification_hints.vm_path #=> String
resp.source_properties.identification_hints.vm_ware_uuid #=> String
resp.source_properties.last_updated_date_time #=> String
resp.source_properties.network_interfaces #=> Array
resp.source_properties.network_interfaces[0].ips #=> Array
resp.source_properties.network_interfaces[0].ips[0] #=> String
resp.source_properties.network_interfaces[0].is_primary #=> Boolean
resp.source_properties.network_interfaces[0].mac_address #=> String
resp.source_properties.os.full_string #=> String
resp.source_properties.ram_bytes #=> Integer
resp.source_properties.recommended_instance_type #=> String
resp.source_server_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.user_provided_id #=> String
resp.vcenter_client_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Request to finalize Cutover by Source Account ID.

  • :source_server_id (required, String) —

    Request to finalize Cutover by Source Server ID.

Returns:

See Also:



2180
2181
2182
2183
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 2180

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

#get_launch_configuration(params = {}) ⇒ Types::LaunchConfiguration

Lists all LaunchConfigurations available, filtered by Source Server IDs.

Examples:

Request syntax with placeholder values


resp = client.get_launch_configuration({
  account_id: "AccountID",
  source_server_id: "SourceServerID", # required
})

Response structure


resp.boot_mode #=> String, one of "LEGACY_BIOS", "UEFI", "USE_SOURCE"
resp.copy_private_ip #=> Boolean
resp.copy_tags #=> Boolean
resp.ec2_launch_template_id #=> String
resp.enable_map_auto_tagging #=> Boolean
resp.launch_disposition #=> String, one of "STOPPED", "STARTED"
resp.licensing.os_byol #=> Boolean
resp.map_auto_tagging_mpe_id #=> String
resp.name #=> String
resp.post_launch_actions.cloud_watch_log_group_name #=> String
resp.post_launch_actions.deployment #=> String, one of "TEST_AND_CUTOVER", "CUTOVER_ONLY", "TEST_ONLY"
resp.post_launch_actions.s3_log_bucket #=> String
resp.post_launch_actions.s3_output_key_prefix #=> String
resp.post_launch_actions.ssm_documents #=> Array
resp.post_launch_actions.ssm_documents[0].action_name #=> String
resp.post_launch_actions.ssm_documents[0].external_parameters #=> Hash
resp.post_launch_actions.ssm_documents[0].external_parameters["SsmDocumentParameterName"].dynamic_path #=> String
resp.post_launch_actions.ssm_documents[0].must_succeed_for_cutover #=> Boolean
resp.post_launch_actions.ssm_documents[0].parameters #=> Hash
resp.post_launch_actions.ssm_documents[0].parameters["SsmDocumentParameterName"] #=> Array
resp.post_launch_actions.ssm_documents[0].parameters["SsmDocumentParameterName"][0].parameter_name #=> String
resp.post_launch_actions.ssm_documents[0].parameters["SsmDocumentParameterName"][0].parameter_type #=> String, one of "STRING"
resp.post_launch_actions.ssm_documents[0].ssm_document_name #=> String
resp.post_launch_actions.ssm_documents[0].timeout_seconds #=> Integer
resp.source_server_id #=> String
resp.target_instance_type_right_sizing_method #=> String, one of "NONE", "BASIC"

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Request to get Launch Configuration information by Account ID.

  • :source_server_id (required, String) —

    Request to get Launch Configuration information by Source Server ID.

Returns:

See Also:



2249
2250
2251
2252
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 2249

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

#get_replication_configuration(params = {}) ⇒ Types::ReplicationConfiguration

Lists all ReplicationConfigurations, filtered by Source Server ID.

Examples:

Request syntax with placeholder values


resp = client.get_replication_configuration({
  account_id: "AccountID",
  source_server_id: "SourceServerID", # required
})

Response structure


resp.associate_default_security_group #=> Boolean
resp.bandwidth_throttling #=> Integer
resp.create_public_ip #=> Boolean
resp.data_plane_routing #=> String, one of "PRIVATE_IP", "PUBLIC_IP"
resp.default_large_staging_disk_type #=> String, one of "GP2", "ST1", "GP3"
resp.ebs_encryption #=> String, one of "DEFAULT", "CUSTOM"
resp.ebs_encryption_key_arn #=> String
resp.name #=> String
resp.replicated_disks #=> Array
resp.replicated_disks[0].device_name #=> String
resp.replicated_disks[0].iops #=> Integer
resp.replicated_disks[0].is_boot_disk #=> Boolean
resp.replicated_disks[0].staging_disk_type #=> String, one of "AUTO", "GP2", "IO1", "SC1", "ST1", "STANDARD", "GP3", "IO2"
resp.replicated_disks[0].throughput #=> Integer
resp.replication_server_instance_type #=> String
resp.replication_servers_security_groups_i_ds #=> Array
resp.replication_servers_security_groups_i_ds[0] #=> String
resp.source_server_id #=> String
resp.staging_area_subnet_id #=> String
resp.staging_area_tags #=> Hash
resp.staging_area_tags["TagKey"] #=> String
resp.use_dedicated_replication_server #=> Boolean
resp.use_fips_endpoint #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Request to get Replication Configuration by Account ID.

  • :source_server_id (required, String) —

    Request to get Replication Configuration by Source Server ID.

Returns:

See Also:



2318
2319
2320
2321
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 2318

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

#initialize_service(params = {}) ⇒ Struct

Initialize Application Migration Service.

Parameters:

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

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2331
2332
2333
2334
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 2331

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

#list_applications(params = {}) ⇒ Types::ListApplicationsResponse

Retrieves all applications or multiple applications by ID.

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_applications({
  account_id: "AccountID",
  filters: {
    application_i_ds: ["ApplicationID"],
    is_archived: false,
    wave_i_ds: ["WaveID"],
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].application_aggregated_status.health_status #=> String, one of "HEALTHY", "LAGGING", "ERROR"
resp.items[0].application_aggregated_status.last_update_date_time #=> String
resp.items[0].application_aggregated_status.progress_status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED"
resp.items[0].application_aggregated_status.total_source_servers #=> Integer
resp.items[0].application_id #=> String
resp.items[0].arn #=> String
resp.items[0].creation_date_time #=> String
resp.items[0].description #=> String
resp.items[0].is_archived #=> Boolean
resp.items[0].last_modified_date_time #=> String
resp.items[0].name #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.items[0].wave_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Applications list Account ID.

  • :filters (Types::ListApplicationsRequestFilters) —

    Applications list filters.

  • :max_results (Integer) —

    Maximum results to return when listing applications.

  • :next_token (String) —

    Request next token.

Returns:

See Also:



2393
2394
2395
2396
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 2393

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

#list_connectors(params = {}) ⇒ Types::ListConnectorsResponse

List Connectors.

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_connectors({
  filters: {
    connector_i_ds: ["ConnectorID"],
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].connector_id #=> String
resp.items[0].name #=> String
resp.items[0].ssm_command_config.cloud_watch_log_group_name #=> String
resp.items[0].ssm_command_config.cloud_watch_output_enabled #=> Boolean
resp.items[0].ssm_command_config.output_s3_bucket_name #=> String
resp.items[0].ssm_command_config.s3_output_enabled #=> Boolean
resp.items[0].ssm_instance_id #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filters (Types::ListConnectorsRequestFilters) —

    List Connectors Request filters.

  • :max_results (Integer) —

    List Connectors Request max results.

  • :next_token (String) —

    List Connectors Request next token.

Returns:

See Also:



2445
2446
2447
2448
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 2445

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

#list_export_errors(params = {}) ⇒ Types::ListExportErrorsResponse

List export errors.

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_export_errors({
  export_id: "ExportID", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].error_data.raw_error #=> String
resp.items[0].error_date_time #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :export_id (required, String) —

    List export errors request export id.

  • :max_results (Integer) —

    List export errors request max results.

  • :next_token (String) —

    List export errors request next token.

Returns:

See Also:



2487
2488
2489
2490
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 2487

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

#list_exports(params = {}) ⇒ Types::ListExportsResponse

List exports.

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_exports({
  filters: {
    export_i_ds: ["ExportID"],
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].creation_date_time #=> String
resp.items[0].end_date_time #=> String
resp.items[0].export_id #=> String
resp.items[0].progress_percentage #=> Float
resp.items[0].s3_bucket #=> String
resp.items[0].s3_bucket_owner #=> String
resp.items[0].s3_key #=> String
resp.items[0].status #=> String, one of "PENDING", "STARTED", "FAILED", "SUCCEEDED"
resp.items[0].summary.applications_count #=> Integer
resp.items[0].summary.servers_count #=> Integer
resp.items[0].summary.waves_count #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filters (Types::ListExportsRequestFilters) —

    List exports request filters.

  • :max_results (Integer) —

    List export request max results.

  • :next_token (String) —

    List export request next token.

Returns:

See Also:



2540
2541
2542
2543
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 2540

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

#list_import_errors(params = {}) ⇒ Types::ListImportErrorsResponse

List import errors.

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_import_errors({
  import_id: "ImportID", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].error_data. #=> String
resp.items[0].error_data.application_id #=> String
resp.items[0].error_data.ec2_launch_template_id #=> String
resp.items[0].error_data.raw_error #=> String
resp.items[0].error_data.row_number #=> Integer
resp.items[0].error_data.source_server_id #=> String
resp.items[0].error_data.wave_id #=> String
resp.items[0].error_date_time #=> String
resp.items[0].error_type #=> String, one of "VALIDATION_ERROR", "PROCESSING_ERROR"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :import_id (required, String) —

    List import errors request import id.

  • :max_results (Integer) —

    List import errors request max results.

  • :next_token (String) —

    List import errors request next token.

Returns:

See Also:



2589
2590
2591
2592
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 2589

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

#list_imports(params = {}) ⇒ Types::ListImportsResponse

List imports.

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_imports({
  filters: {
    import_i_ds: ["ImportID"],
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].creation_date_time #=> String
resp.items[0].end_date_time #=> String
resp.items[0].import_id #=> String
resp.items[0].progress_percentage #=> Float
resp.items[0].s3_bucket_source.s3_bucket #=> String
resp.items[0].s3_bucket_source.s3_bucket_owner #=> String
resp.items[0].s3_bucket_source.s3_key #=> String
resp.items[0].status #=> String, one of "PENDING", "STARTED", "FAILED", "SUCCEEDED"
resp.items[0].summary.applications.created_count #=> Integer
resp.items[0].summary.applications.modified_count #=> Integer
resp.items[0].summary.servers.created_count #=> Integer
resp.items[0].summary.servers.modified_count #=> Integer
resp.items[0].summary.waves.created_count #=> Integer
resp.items[0].summary.waves.modified_count #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filters (Types::ListImportsRequestFilters) —

    List imports request filters.

  • :max_results (Integer) —

    List imports request max results.

  • :next_token (String) —

    List imports request next token.

Returns:

See Also:



2645
2646
2647
2648
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 2645

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

#list_managed_accounts(params = {}) ⇒ Types::ListManagedAccountsResponse

List Managed Accounts.

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_managed_accounts({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0]. #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    List managed accounts request max results.

  • :next_token (String) —

    List managed accounts request next token.

Returns:

See Also:



2682
2683
2684
2685
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 2682

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

#list_source_server_actions(params = {}) ⇒ Types::ListSourceServerActionsResponse

List source server post migration custom actions.

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_server_actions({
  account_id: "AccountID",
  filters: {
    action_i_ds: ["ActionID"],
  },
  max_results: 1,
  next_token: "PaginationToken",
  source_server_id: "SourceServerID", # required
})

Response structure


resp.items #=> Array
resp.items[0].action_id #=> String
resp.items[0].action_name #=> String
resp.items[0].active #=> Boolean
resp.items[0].category #=> String, one of "DISASTER_RECOVERY", "OPERATING_SYSTEM", "LICENSE_AND_SUBSCRIPTION", "VALIDATION", "OBSERVABILITY", "REFACTORING", "SECURITY", "NETWORKING", "CONFIGURATION", "BACKUP", "OTHER"
resp.items[0].description #=> String
resp.items[0].document_identifier #=> String
resp.items[0].document_version #=> String
resp.items[0].external_parameters #=> Hash
resp.items[0].external_parameters["SsmDocumentParameterName"].dynamic_path #=> String
resp.items[0].must_succeed_for_cutover #=> Boolean
resp.items[0].order #=> Integer
resp.items[0].parameters #=> Hash
resp.items[0].parameters["SsmDocumentParameterName"] #=> Array
resp.items[0].parameters["SsmDocumentParameterName"][0].parameter_name #=> String
resp.items[0].parameters["SsmDocumentParameterName"][0].parameter_type #=> String, one of "STRING"
resp.items[0].timeout_seconds #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Account ID to return when listing source server post migration custom actions.

  • :filters (Types::SourceServerActionsRequestFilters) —

    Filters to apply when listing source server post migration custom actions.

  • :max_results (Integer) —

    Maximum amount of items to return when listing source server post migration custom actions.

  • :next_token (String) —

    Next token to use when listing source server post migration custom actions.

  • :source_server_id (required, String) —

    Source server ID.

Returns:

See Also:



2752
2753
2754
2755
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 2752

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

List all tags for your Application Migration Service resources.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ARN", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    List tags for resource request by ARN.

Returns:

See Also:



2781
2782
2783
2784
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 2781

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

#list_template_actions(params = {}) ⇒ Types::ListTemplateActionsResponse

List template post migration custom actions.

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_template_actions({
  filters: {
    action_i_ds: ["ActionID"],
  },
  launch_configuration_template_id: "LaunchConfigurationTemplateID", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].action_id #=> String
resp.items[0].action_name #=> String
resp.items[0].active #=> Boolean
resp.items[0].category #=> String, one of "DISASTER_RECOVERY", "OPERATING_SYSTEM", "LICENSE_AND_SUBSCRIPTION", "VALIDATION", "OBSERVABILITY", "REFACTORING", "SECURITY", "NETWORKING", "CONFIGURATION", "BACKUP", "OTHER"
resp.items[0].description #=> String
resp.items[0].document_identifier #=> String
resp.items[0].document_version #=> String
resp.items[0].external_parameters #=> Hash
resp.items[0].external_parameters["SsmDocumentParameterName"].dynamic_path #=> String
resp.items[0].must_succeed_for_cutover #=> Boolean
resp.items[0].operating_system #=> String
resp.items[0].order #=> Integer
resp.items[0].parameters #=> Hash
resp.items[0].parameters["SsmDocumentParameterName"] #=> Array
resp.items[0].parameters["SsmDocumentParameterName"][0].parameter_name #=> String
resp.items[0].parameters["SsmDocumentParameterName"][0].parameter_type #=> String, one of "STRING"
resp.items[0].timeout_seconds #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filters (Types::TemplateActionsRequestFilters) —

    Filters to apply when listing template post migration custom actions.

  • :launch_configuration_template_id (required, String) —

    Launch configuration template ID.

  • :max_results (Integer) —

    Maximum amount of items to return when listing template post migration custom actions.

  • :next_token (String) —

    Next token to use when listing template post migration custom actions.

Returns:

See Also:



2845
2846
2847
2848
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 2845

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

#list_waves(params = {}) ⇒ Types::ListWavesResponse

Retrieves all waves or multiple waves by ID.

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_waves({
  account_id: "AccountID",
  filters: {
    is_archived: false,
    wave_i_ds: ["WaveID"],
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].creation_date_time #=> String
resp.items[0].description #=> String
resp.items[0].is_archived #=> Boolean
resp.items[0].last_modified_date_time #=> String
resp.items[0].name #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.items[0].wave_aggregated_status.health_status #=> String, one of "HEALTHY", "LAGGING", "ERROR"
resp.items[0].wave_aggregated_status.last_update_date_time #=> String
resp.items[0].wave_aggregated_status.progress_status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED"
resp.items[0].wave_aggregated_status.replication_started_date_time #=> String
resp.items[0].wave_aggregated_status.total_applications #=> Integer
resp.items[0].wave_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Request account ID.

  • :filters (Types::ListWavesRequestFilters) —

    Waves list filters.

  • :max_results (Integer) —

    Maximum results to return when listing waves.

  • :next_token (String) —

    Request next token.

Returns:

See Also:



2906
2907
2908
2909
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 2906

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

#mark_as_archived(params = {}) ⇒ Types::SourceServer

Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID. This command only works for SourceServers with a lifecycle. state which equals DISCONNECTED or CUTOVER.

Examples:

Request syntax with placeholder values


resp = client.mark_as_archived({
  account_id: "AccountID",
  source_server_id: "SourceServerID", # required
})

Response structure


resp.application_id #=> String
resp.arn #=> String
resp.connector_action.connector_arn #=> String
resp.connector_action.credentials_secret_arn #=> String
resp.data_replication_info.data_replication_error.error #=> String, one of "AGENT_NOT_SEEN", "SNAPSHOTS_FAILURE", "NOT_CONVERGING", "UNSTABLE_NETWORK", "FAILED_TO_CREATE_SECURITY_GROUP", "FAILED_TO_LAUNCH_REPLICATION_SERVER", "FAILED_TO_BOOT_REPLICATION_SERVER", "FAILED_TO_AUTHENTICATE_WITH_SERVICE", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", "FAILED_TO_CREATE_STAGING_DISKS", "FAILED_TO_ATTACH_STAGING_DISKS", "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", "FAILED_TO_START_DATA_TRANSFER", "UNSUPPORTED_VM_CONFIGURATION", "LAST_SNAPSHOT_JOB_FAILED"
resp.data_replication_info.data_replication_error.raw_error #=> String
resp.data_replication_info.data_replication_initiation.next_attempt_date_time #=> String
resp.data_replication_info.data_replication_initiation.start_date_time #=> String
resp.data_replication_info.data_replication_initiation.steps #=> Array
resp.data_replication_info.data_replication_initiation.steps[0].name #=> String, one of "WAIT", "CREATE_SECURITY_GROUP", "LAUNCH_REPLICATION_SERVER", "BOOT_REPLICATION_SERVER", "AUTHENTICATE_WITH_SERVICE", "DOWNLOAD_REPLICATION_SOFTWARE", "CREATE_STAGING_DISKS", "ATTACH_STAGING_DISKS", "PAIR_REPLICATION_SERVER_WITH_AGENT", "CONNECT_AGENT_TO_REPLICATION_SERVER", "START_DATA_TRANSFER"
resp.data_replication_info.data_replication_initiation.steps[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "SKIPPED"
resp.data_replication_info.data_replication_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED", "PENDING_SNAPSHOT_SHIPPING", "SHIPPING_SNAPSHOT"
resp.data_replication_info.eta_date_time #=> String
resp.data_replication_info.lag_duration #=> String
resp.data_replication_info.last_snapshot_date_time #=> String
resp.data_replication_info.replicated_disks #=> Array
resp.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].device_name #=> String
resp.data_replication_info.replicated_disks[0].replicated_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].rescanned_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].total_storage_bytes #=> Integer
resp.fqdn_for_action_framework #=> String
resp.is_archived #=> Boolean
resp.launched_instance.ec2_instance_id #=> String
resp.launched_instance.first_boot #=> String, one of "WAITING", "SUCCEEDED", "UNKNOWN", "STOPPED"
resp.launched_instance.job_id #=> String
resp.life_cycle.added_to_service_date_time #=> String
resp.life_cycle.elapsed_replication_duration #=> String
resp.life_cycle.first_byte_date_time #=> String
resp.life_cycle.last_cutover.finalized.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.job_id #=> String
resp.life_cycle.last_cutover.reverted.api_call_date_time #=> String
resp.life_cycle.last_seen_by_service_date_time #=> String
resp.life_cycle.last_test.finalized.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.job_id #=> String
resp.life_cycle.last_test.reverted.api_call_date_time #=> String
resp.life_cycle.state #=> String, one of "STOPPED", "NOT_READY", "READY_FOR_TEST", "TESTING", "READY_FOR_CUTOVER", "CUTTING_OVER", "CUTOVER", "DISCONNECTED", "DISCOVERED", "PENDING_INSTALLATION"
resp.replication_type #=> String, one of "AGENT_BASED", "SNAPSHOT_SHIPPING"
resp.source_properties.cpus #=> Array
resp.source_properties.cpus[0].cores #=> Integer
resp.source_properties.cpus[0].model_name #=> String
resp.source_properties.disks #=> Array
resp.source_properties.disks[0].bytes #=> Integer
resp.source_properties.disks[0].device_name #=> String
resp.source_properties.identification_hints.aws_instance_id #=> String
resp.source_properties.identification_hints.fqdn #=> String
resp.source_properties.identification_hints.hostname #=> String
resp.source_properties.identification_hints.vm_path #=> String
resp.source_properties.identification_hints.vm_ware_uuid #=> String
resp.source_properties.last_updated_date_time #=> String
resp.source_properties.network_interfaces #=> Array
resp.source_properties.network_interfaces[0].ips #=> Array
resp.source_properties.network_interfaces[0].ips[0] #=> String
resp.source_properties.network_interfaces[0].is_primary #=> Boolean
resp.source_properties.network_interfaces[0].mac_address #=> String
resp.source_properties.os.full_string #=> String
resp.source_properties.ram_bytes #=> Integer
resp.source_properties.recommended_instance_type #=> String
resp.source_server_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.user_provided_id #=> String
resp.vcenter_client_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Mark as archived by Account ID.

  • :source_server_id (required, String) —

    Mark as archived by Source Server ID.

Returns:

See Also:



3018
3019
3020
3021
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 3018

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

#pause_replication(params = {}) ⇒ Types::SourceServer

Pause Replication.

Examples:

Request syntax with placeholder values


resp = client.pause_replication({
  account_id: "AccountID",
  source_server_id: "SourceServerID", # required
})

Response structure


resp.application_id #=> String
resp.arn #=> String
resp.connector_action.connector_arn #=> String
resp.connector_action.credentials_secret_arn #=> String
resp.data_replication_info.data_replication_error.error #=> String, one of "AGENT_NOT_SEEN", "SNAPSHOTS_FAILURE", "NOT_CONVERGING", "UNSTABLE_NETWORK", "FAILED_TO_CREATE_SECURITY_GROUP", "FAILED_TO_LAUNCH_REPLICATION_SERVER", "FAILED_TO_BOOT_REPLICATION_SERVER", "FAILED_TO_AUTHENTICATE_WITH_SERVICE", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", "FAILED_TO_CREATE_STAGING_DISKS", "FAILED_TO_ATTACH_STAGING_DISKS", "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", "FAILED_TO_START_DATA_TRANSFER", "UNSUPPORTED_VM_CONFIGURATION", "LAST_SNAPSHOT_JOB_FAILED"
resp.data_replication_info.data_replication_error.raw_error #=> String
resp.data_replication_info.data_replication_initiation.next_attempt_date_time #=> String
resp.data_replication_info.data_replication_initiation.start_date_time #=> String
resp.data_replication_info.data_replication_initiation.steps #=> Array
resp.data_replication_info.data_replication_initiation.steps[0].name #=> String, one of "WAIT", "CREATE_SECURITY_GROUP", "LAUNCH_REPLICATION_SERVER", "BOOT_REPLICATION_SERVER", "AUTHENTICATE_WITH_SERVICE", "DOWNLOAD_REPLICATION_SOFTWARE", "CREATE_STAGING_DISKS", "ATTACH_STAGING_DISKS", "PAIR_REPLICATION_SERVER_WITH_AGENT", "CONNECT_AGENT_TO_REPLICATION_SERVER", "START_DATA_TRANSFER"
resp.data_replication_info.data_replication_initiation.steps[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "SKIPPED"
resp.data_replication_info.data_replication_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED", "PENDING_SNAPSHOT_SHIPPING", "SHIPPING_SNAPSHOT"
resp.data_replication_info.eta_date_time #=> String
resp.data_replication_info.lag_duration #=> String
resp.data_replication_info.last_snapshot_date_time #=> String
resp.data_replication_info.replicated_disks #=> Array
resp.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].device_name #=> String
resp.data_replication_info.replicated_disks[0].replicated_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].rescanned_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].total_storage_bytes #=> Integer
resp.fqdn_for_action_framework #=> String
resp.is_archived #=> Boolean
resp.launched_instance.ec2_instance_id #=> String
resp.launched_instance.first_boot #=> String, one of "WAITING", "SUCCEEDED", "UNKNOWN", "STOPPED"
resp.launched_instance.job_id #=> String
resp.life_cycle.added_to_service_date_time #=> String
resp.life_cycle.elapsed_replication_duration #=> String
resp.life_cycle.first_byte_date_time #=> String
resp.life_cycle.last_cutover.finalized.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.job_id #=> String
resp.life_cycle.last_cutover.reverted.api_call_date_time #=> String
resp.life_cycle.last_seen_by_service_date_time #=> String
resp.life_cycle.last_test.finalized.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.job_id #=> String
resp.life_cycle.last_test.reverted.api_call_date_time #=> String
resp.life_cycle.state #=> String, one of "STOPPED", "NOT_READY", "READY_FOR_TEST", "TESTING", "READY_FOR_CUTOVER", "CUTTING_OVER", "CUTOVER", "DISCONNECTED", "DISCOVERED", "PENDING_INSTALLATION"
resp.replication_type #=> String, one of "AGENT_BASED", "SNAPSHOT_SHIPPING"
resp.source_properties.cpus #=> Array
resp.source_properties.cpus[0].cores #=> Integer
resp.source_properties.cpus[0].model_name #=> String
resp.source_properties.disks #=> Array
resp.source_properties.disks[0].bytes #=> Integer
resp.source_properties.disks[0].device_name #=> String
resp.source_properties.identification_hints.aws_instance_id #=> String
resp.source_properties.identification_hints.fqdn #=> String
resp.source_properties.identification_hints.hostname #=> String
resp.source_properties.identification_hints.vm_path #=> String
resp.source_properties.identification_hints.vm_ware_uuid #=> String
resp.source_properties.last_updated_date_time #=> String
resp.source_properties.network_interfaces #=> Array
resp.source_properties.network_interfaces[0].ips #=> Array
resp.source_properties.network_interfaces[0].ips[0] #=> String
resp.source_properties.network_interfaces[0].is_primary #=> Boolean
resp.source_properties.network_interfaces[0].mac_address #=> String
resp.source_properties.os.full_string #=> String
resp.source_properties.ram_bytes #=> Integer
resp.source_properties.recommended_instance_type #=> String
resp.source_server_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.user_provided_id #=> String
resp.vcenter_client_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Pause Replication Request account ID.

  • :source_server_id (required, String) —

    Pause Replication Request source server ID.

Returns:

See Also:



3127
3128
3129
3130
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 3127

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

#put_source_server_action(params = {}) ⇒ Types::SourceServerActionDocument

Put source server post migration custom action.

Examples:

Request syntax with placeholder values


resp = client.put_source_server_action({
  account_id: "AccountID",
  action_id: "ActionID", # required
  action_name: "ActionName", # required
  active: false,
  category: "DISASTER_RECOVERY", # accepts DISASTER_RECOVERY, OPERATING_SYSTEM, LICENSE_AND_SUBSCRIPTION, VALIDATION, OBSERVABILITY, REFACTORING, SECURITY, NETWORKING, CONFIGURATION, BACKUP, OTHER
  description: "ActionDescription",
  document_identifier: "BoundedString", # required
  document_version: "DocumentVersion",
  external_parameters: {
    "SsmDocumentParameterName" => {
      dynamic_path: "JmesPathString",
    },
  },
  must_succeed_for_cutover: false,
  order: 1, # required
  parameters: {
    "SsmDocumentParameterName" => [
      {
        parameter_name: "SsmParameterStoreParameterName", # required
        parameter_type: "STRING", # required, accepts STRING
      },
    ],
  },
  source_server_id: "SourceServerID", # required
  timeout_seconds: 1,
})

Response structure


resp.action_id #=> String
resp.action_name #=> String
resp.active #=> Boolean
resp.category #=> String, one of "DISASTER_RECOVERY", "OPERATING_SYSTEM", "LICENSE_AND_SUBSCRIPTION", "VALIDATION", "OBSERVABILITY", "REFACTORING", "SECURITY", "NETWORKING", "CONFIGURATION", "BACKUP", "OTHER"
resp.description #=> String
resp.document_identifier #=> String
resp.document_version #=> String
resp.external_parameters #=> Hash
resp.external_parameters["SsmDocumentParameterName"].dynamic_path #=> String
resp.must_succeed_for_cutover #=> Boolean
resp.order #=> Integer
resp.parameters #=> Hash
resp.parameters["SsmDocumentParameterName"] #=> Array
resp.parameters["SsmDocumentParameterName"][0].parameter_name #=> String
resp.parameters["SsmDocumentParameterName"][0].parameter_type #=> String, one of "STRING"
resp.timeout_seconds #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Source server post migration custom account ID.

  • :action_id (required, String) —

    Source server post migration custom action ID.

  • :action_name (required, String) —

    Source server post migration custom action name.

  • :active (Boolean) —

    Source server post migration custom action active status.

  • :category (String) —

    Source server post migration custom action category.

  • :description (String) —

    Source server post migration custom action description.

  • :document_identifier (required, String) —

    Source server post migration custom action document identifier.

  • :document_version (String) —

    Source server post migration custom action document version.

  • :external_parameters (Hash<String,Types::SsmExternalParameter>) —

    Source server post migration custom action external parameters.

  • :must_succeed_for_cutover (Boolean) —

    Source server post migration custom action must succeed for cutover.

  • :order (required, Integer) —

    Source server post migration custom action order.

  • :parameters (Hash<String,Array>) —

    Source server post migration custom action parameters.

  • :source_server_id (required, String) —

    Source server ID.

  • :timeout_seconds (Integer) —

    Source server post migration custom action timeout in seconds.

Returns:

See Also:



3244
3245
3246
3247
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 3244

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

#put_template_action(params = {}) ⇒ Types::TemplateActionDocument

Put template post migration custom action.

Examples:

Request syntax with placeholder values


resp = client.put_template_action({
  action_id: "ActionID", # required
  action_name: "BoundedString", # required
  active: false,
  category: "DISASTER_RECOVERY", # accepts DISASTER_RECOVERY, OPERATING_SYSTEM, LICENSE_AND_SUBSCRIPTION, VALIDATION, OBSERVABILITY, REFACTORING, SECURITY, NETWORKING, CONFIGURATION, BACKUP, OTHER
  description: "ActionDescription",
  document_identifier: "BoundedString", # required
  document_version: "DocumentVersion",
  external_parameters: {
    "SsmDocumentParameterName" => {
      dynamic_path: "JmesPathString",
    },
  },
  launch_configuration_template_id: "LaunchConfigurationTemplateID", # required
  must_succeed_for_cutover: false,
  operating_system: "OperatingSystemString",
  order: 1, # required
  parameters: {
    "SsmDocumentParameterName" => [
      {
        parameter_name: "SsmParameterStoreParameterName", # required
        parameter_type: "STRING", # required, accepts STRING
      },
    ],
  },
  timeout_seconds: 1,
})

Response structure


resp.action_id #=> String
resp.action_name #=> String
resp.active #=> Boolean
resp.category #=> String, one of "DISASTER_RECOVERY", "OPERATING_SYSTEM", "LICENSE_AND_SUBSCRIPTION", "VALIDATION", "OBSERVABILITY", "REFACTORING", "SECURITY", "NETWORKING", "CONFIGURATION", "BACKUP", "OTHER"
resp.description #=> String
resp.document_identifier #=> String
resp.document_version #=> String
resp.external_parameters #=> Hash
resp.external_parameters["SsmDocumentParameterName"].dynamic_path #=> String
resp.must_succeed_for_cutover #=> Boolean
resp.operating_system #=> String
resp.order #=> Integer
resp.parameters #=> Hash
resp.parameters["SsmDocumentParameterName"] #=> Array
resp.parameters["SsmDocumentParameterName"][0].parameter_name #=> String
resp.parameters["SsmDocumentParameterName"][0].parameter_type #=> String, one of "STRING"
resp.timeout_seconds #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :action_id (required, String) —

    Template post migration custom action ID.

  • :action_name (required, String) —

    Template post migration custom action name.

  • :active (Boolean) —

    Template post migration custom action active status.

  • :category (String) —

    Template post migration custom action category.

  • :description (String) —

    Template post migration custom action description.

  • :document_identifier (required, String) —

    Template post migration custom action document identifier.

  • :document_version (String) —

    Template post migration custom action document version.

  • :external_parameters (Hash<String,Types::SsmExternalParameter>) —

    Template post migration custom action external parameters.

  • :launch_configuration_template_id (required, String) —

    Launch configuration template ID.

  • :must_succeed_for_cutover (Boolean) —

    Template post migration custom action must succeed for cutover.

  • :operating_system (String) —

    Operating system eligible for this template post migration custom action.

  • :order (required, Integer) —

    Template post migration custom action order.

  • :parameters (Hash<String,Array>) —

    Template post migration custom action parameters.

  • :timeout_seconds (Integer) —

    Template post migration custom action timeout in seconds.

Returns:

See Also:



3364
3365
3366
3367
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 3364

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

#remove_source_server_action(params = {}) ⇒ Struct

Remove source server post migration custom action.

Examples:

Request syntax with placeholder values


resp = client.remove_source_server_action({
  account_id: "AccountID",
  action_id: "ActionID", # required
  source_server_id: "SourceServerID", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Source server post migration account ID.

  • :action_id (required, String) —

    Source server post migration custom action ID to remove.

  • :source_server_id (required, String) —

    Source server ID of the post migration custom action to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3394
3395
3396
3397
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 3394

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

#remove_template_action(params = {}) ⇒ Struct

Remove template post migration custom action.

Examples:

Request syntax with placeholder values


resp = client.remove_template_action({
  action_id: "ActionID", # required
  launch_configuration_template_id: "LaunchConfigurationTemplateID", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :action_id (required, String) —

    Template post migration custom action ID to remove.

  • :launch_configuration_template_id (required, String) —

    Launch configuration template ID of the post migration custom action to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3421
3422
3423
3424
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 3421

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

#resume_replication(params = {}) ⇒ Types::SourceServer

Resume Replication.

Examples:

Request syntax with placeholder values


resp = client.resume_replication({
  account_id: "AccountID",
  source_server_id: "SourceServerID", # required
})

Response structure


resp.application_id #=> String
resp.arn #=> String
resp.connector_action.connector_arn #=> String
resp.connector_action.credentials_secret_arn #=> String
resp.data_replication_info.data_replication_error.error #=> String, one of "AGENT_NOT_SEEN", "SNAPSHOTS_FAILURE", "NOT_CONVERGING", "UNSTABLE_NETWORK", "FAILED_TO_CREATE_SECURITY_GROUP", "FAILED_TO_LAUNCH_REPLICATION_SERVER", "FAILED_TO_BOOT_REPLICATION_SERVER", "FAILED_TO_AUTHENTICATE_WITH_SERVICE", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", "FAILED_TO_CREATE_STAGING_DISKS", "FAILED_TO_ATTACH_STAGING_DISKS", "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", "FAILED_TO_START_DATA_TRANSFER", "UNSUPPORTED_VM_CONFIGURATION", "LAST_SNAPSHOT_JOB_FAILED"
resp.data_replication_info.data_replication_error.raw_error #=> String
resp.data_replication_info.data_replication_initiation.next_attempt_date_time #=> String
resp.data_replication_info.data_replication_initiation.start_date_time #=> String
resp.data_replication_info.data_replication_initiation.steps #=> Array
resp.data_replication_info.data_replication_initiation.steps[0].name #=> String, one of "WAIT", "CREATE_SECURITY_GROUP", "LAUNCH_REPLICATION_SERVER", "BOOT_REPLICATION_SERVER", "AUTHENTICATE_WITH_SERVICE", "DOWNLOAD_REPLICATION_SOFTWARE", "CREATE_STAGING_DISKS", "ATTACH_STAGING_DISKS", "PAIR_REPLICATION_SERVER_WITH_AGENT", "CONNECT_AGENT_TO_REPLICATION_SERVER", "START_DATA_TRANSFER"
resp.data_replication_info.data_replication_initiation.steps[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "SKIPPED"
resp.data_replication_info.data_replication_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED", "PENDING_SNAPSHOT_SHIPPING", "SHIPPING_SNAPSHOT"
resp.data_replication_info.eta_date_time #=> String
resp.data_replication_info.lag_duration #=> String
resp.data_replication_info.last_snapshot_date_time #=> String
resp.data_replication_info.replicated_disks #=> Array
resp.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].device_name #=> String
resp.data_replication_info.replicated_disks[0].replicated_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].rescanned_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].total_storage_bytes #=> Integer
resp.fqdn_for_action_framework #=> String
resp.is_archived #=> Boolean
resp.launched_instance.ec2_instance_id #=> String
resp.launched_instance.first_boot #=> String, one of "WAITING", "SUCCEEDED", "UNKNOWN", "STOPPED"
resp.launched_instance.job_id #=> String
resp.life_cycle.added_to_service_date_time #=> String
resp.life_cycle.elapsed_replication_duration #=> String
resp.life_cycle.first_byte_date_time #=> String
resp.life_cycle.last_cutover.finalized.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.job_id #=> String
resp.life_cycle.last_cutover.reverted.api_call_date_time #=> String
resp.life_cycle.last_seen_by_service_date_time #=> String
resp.life_cycle.last_test.finalized.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.job_id #=> String
resp.life_cycle.last_test.reverted.api_call_date_time #=> String
resp.life_cycle.state #=> String, one of "STOPPED", "NOT_READY", "READY_FOR_TEST", "TESTING", "READY_FOR_CUTOVER", "CUTTING_OVER", "CUTOVER", "DISCONNECTED", "DISCOVERED", "PENDING_INSTALLATION"
resp.replication_type #=> String, one of "AGENT_BASED", "SNAPSHOT_SHIPPING"
resp.source_properties.cpus #=> Array
resp.source_properties.cpus[0].cores #=> Integer
resp.source_properties.cpus[0].model_name #=> String
resp.source_properties.disks #=> Array
resp.source_properties.disks[0].bytes #=> Integer
resp.source_properties.disks[0].device_name #=> String
resp.source_properties.identification_hints.aws_instance_id #=> String
resp.source_properties.identification_hints.fqdn #=> String
resp.source_properties.identification_hints.hostname #=> String
resp.source_properties.identification_hints.vm_path #=> String
resp.source_properties.identification_hints.vm_ware_uuid #=> String
resp.source_properties.last_updated_date_time #=> String
resp.source_properties.network_interfaces #=> Array
resp.source_properties.network_interfaces[0].ips #=> Array
resp.source_properties.network_interfaces[0].ips[0] #=> String
resp.source_properties.network_interfaces[0].is_primary #=> Boolean
resp.source_properties.network_interfaces[0].mac_address #=> String
resp.source_properties.os.full_string #=> String
resp.source_properties.ram_bytes #=> Integer
resp.source_properties.recommended_instance_type #=> String
resp.source_server_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.user_provided_id #=> String
resp.vcenter_client_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Resume Replication Request account ID.

  • :source_server_id (required, String) —

    Resume Replication Request source server ID.

Returns:

See Also:



3530
3531
3532
3533
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 3530

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

#retry_data_replication(params = {}) ⇒ Types::SourceServer

Causes the data replication initiation sequence to begin immediately upon next Handshake for specified SourceServer IDs, regardless of when the previous initiation started. This command will not work if the SourceServer is not stalled or is in a DISCONNECTED or STOPPED state.

Examples:

Request syntax with placeholder values


resp = client.retry_data_replication({
  account_id: "AccountID",
  source_server_id: "SourceServerID", # required
})

Response structure


resp.application_id #=> String
resp.arn #=> String
resp.connector_action.connector_arn #=> String
resp.connector_action.credentials_secret_arn #=> String
resp.data_replication_info.data_replication_error.error #=> String, one of "AGENT_NOT_SEEN", "SNAPSHOTS_FAILURE", "NOT_CONVERGING", "UNSTABLE_NETWORK", "FAILED_TO_CREATE_SECURITY_GROUP", "FAILED_TO_LAUNCH_REPLICATION_SERVER", "FAILED_TO_BOOT_REPLICATION_SERVER", "FAILED_TO_AUTHENTICATE_WITH_SERVICE", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", "FAILED_TO_CREATE_STAGING_DISKS", "FAILED_TO_ATTACH_STAGING_DISKS", "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", "FAILED_TO_START_DATA_TRANSFER", "UNSUPPORTED_VM_CONFIGURATION", "LAST_SNAPSHOT_JOB_FAILED"
resp.data_replication_info.data_replication_error.raw_error #=> String
resp.data_replication_info.data_replication_initiation.next_attempt_date_time #=> String
resp.data_replication_info.data_replication_initiation.start_date_time #=> String
resp.data_replication_info.data_replication_initiation.steps #=> Array
resp.data_replication_info.data_replication_initiation.steps[0].name #=> String, one of "WAIT", "CREATE_SECURITY_GROUP", "LAUNCH_REPLICATION_SERVER", "BOOT_REPLICATION_SERVER", "AUTHENTICATE_WITH_SERVICE", "DOWNLOAD_REPLICATION_SOFTWARE", "CREATE_STAGING_DISKS", "ATTACH_STAGING_DISKS", "PAIR_REPLICATION_SERVER_WITH_AGENT", "CONNECT_AGENT_TO_REPLICATION_SERVER", "START_DATA_TRANSFER"
resp.data_replication_info.data_replication_initiation.steps[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "SKIPPED"
resp.data_replication_info.data_replication_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED", "PENDING_SNAPSHOT_SHIPPING", "SHIPPING_SNAPSHOT"
resp.data_replication_info.eta_date_time #=> String
resp.data_replication_info.lag_duration #=> String
resp.data_replication_info.last_snapshot_date_time #=> String
resp.data_replication_info.replicated_disks #=> Array
resp.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].device_name #=> String
resp.data_replication_info.replicated_disks[0].replicated_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].rescanned_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].total_storage_bytes #=> Integer
resp.fqdn_for_action_framework #=> String
resp.is_archived #=> Boolean
resp.launched_instance.ec2_instance_id #=> String
resp.launched_instance.first_boot #=> String, one of "WAITING", "SUCCEEDED", "UNKNOWN", "STOPPED"
resp.launched_instance.job_id #=> String
resp.life_cycle.added_to_service_date_time #=> String
resp.life_cycle.elapsed_replication_duration #=> String
resp.life_cycle.first_byte_date_time #=> String
resp.life_cycle.last_cutover.finalized.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.job_id #=> String
resp.life_cycle.last_cutover.reverted.api_call_date_time #=> String
resp.life_cycle.last_seen_by_service_date_time #=> String
resp.life_cycle.last_test.finalized.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.job_id #=> String
resp.life_cycle.last_test.reverted.api_call_date_time #=> String
resp.life_cycle.state #=> String, one of "STOPPED", "NOT_READY", "READY_FOR_TEST", "TESTING", "READY_FOR_CUTOVER", "CUTTING_OVER", "CUTOVER", "DISCONNECTED", "DISCOVERED", "PENDING_INSTALLATION"
resp.replication_type #=> String, one of "AGENT_BASED", "SNAPSHOT_SHIPPING"
resp.source_properties.cpus #=> Array
resp.source_properties.cpus[0].cores #=> Integer
resp.source_properties.cpus[0].model_name #=> String
resp.source_properties.disks #=> Array
resp.source_properties.disks[0].bytes #=> Integer
resp.source_properties.disks[0].device_name #=> String
resp.source_properties.identification_hints.aws_instance_id #=> String
resp.source_properties.identification_hints.fqdn #=> String
resp.source_properties.identification_hints.hostname #=> String
resp.source_properties.identification_hints.vm_path #=> String
resp.source_properties.identification_hints.vm_ware_uuid #=> String
resp.source_properties.last_updated_date_time #=> String
resp.source_properties.network_interfaces #=> Array
resp.source_properties.network_interfaces[0].ips #=> Array
resp.source_properties.network_interfaces[0].ips[0] #=> String
resp.source_properties.network_interfaces[0].is_primary #=> Boolean
resp.source_properties.network_interfaces[0].mac_address #=> String
resp.source_properties.os.full_string #=> String
resp.source_properties.ram_bytes #=> Integer
resp.source_properties.recommended_instance_type #=> String
resp.source_server_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.user_provided_id #=> String
resp.vcenter_client_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Retry data replication for Account ID.

  • :source_server_id (required, String) —

    Retry data replication for Source Server ID.

Returns:

See Also:



3642
3643
3644
3645
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 3642

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

#start_cutover(params = {}) ⇒ Types::StartCutoverResponse

Launches a Cutover Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartCutover and changes the SourceServer.lifeCycle.state property to CUTTING_OVER.

Examples:

Request syntax with placeholder values


resp = client.start_cutover({
  account_id: "AccountID",
  source_server_i_ds: ["SourceServerID"], # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.job.arn #=> String
resp.job.creation_date_time #=> String
resp.job.end_date_time #=> String
resp.job.initiated_by #=> String, one of "START_TEST", "START_CUTOVER", "DIAGNOSTIC", "TERMINATE"
resp.job.job_id #=> String
resp.job.participating_servers #=> Array
resp.job.participating_servers[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.job.participating_servers[0].launched_ec2_instance_id #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list #=> Array
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].execution_id #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].execution_status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].failure_reason #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.action_name #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.external_parameters #=> Hash
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.external_parameters["SsmDocumentParameterName"].dynamic_path #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.must_succeed_for_cutover #=> Boolean
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.parameters #=> Hash
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.parameters["SsmDocumentParameterName"] #=> Array
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.parameters["SsmDocumentParameterName"][0].parameter_name #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.parameters["SsmDocumentParameterName"][0].parameter_type #=> String, one of "STRING"
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.ssm_document_name #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.timeout_seconds #=> Integer
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document_type #=> String, one of "AUTOMATION", "COMMAND"
resp.job.participating_servers[0].post_launch_actions_status.ssm_agent_discovery_datetime #=> String
resp.job.participating_servers[0].source_server_id #=> String
resp.job.status #=> String, one of "PENDING", "STARTED", "COMPLETED"
resp.job.tags #=> Hash
resp.job.tags["TagKey"] #=> String
resp.job.type #=> String, one of "LAUNCH", "TERMINATE"

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Start Cutover by Account IDs

  • :source_server_i_ds (required, Array<String>) —

    Start Cutover by Source Server IDs.

  • :tags (Hash<String,String>) —

    Start Cutover by Tags.

Returns:

See Also:



3710
3711
3712
3713
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 3710

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

#start_export(params = {}) ⇒ Types::StartExportResponse

Start export.

Examples:

Request syntax with placeholder values


resp = client.start_export({
  s3_bucket: "S3BucketName", # required
  s3_bucket_owner: "AccountID",
  s3_key: "S3Key", # required
})

Response structure


resp.export_task.creation_date_time #=> String
resp.export_task.end_date_time #=> String
resp.export_task.export_id #=> String
resp.export_task.progress_percentage #=> Float
resp.export_task.s3_bucket #=> String
resp.export_task.s3_bucket_owner #=> String
resp.export_task.s3_key #=> String
resp.export_task.status #=> String, one of "PENDING", "STARTED", "FAILED", "SUCCEEDED"
resp.export_task.summary.applications_count #=> Integer
resp.export_task.summary.servers_count #=> Integer
resp.export_task.summary.waves_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :s3_bucket (required, String) —

    Start export request s3 bucket.

  • :s3_bucket_owner (String) —

    Start export request s3 bucket owner.

  • :s3_key (required, String) —

    Start export request s3key.

Returns:

See Also:



3756
3757
3758
3759
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 3756

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

#start_import(params = {}) ⇒ Types::StartImportResponse

Start import.

Examples:

Request syntax with placeholder values


resp = client.start_import({
  client_token: "ClientIdempotencyToken",
  s3_bucket_source: { # required
    s3_bucket: "S3BucketName", # required
    s3_bucket_owner: "AccountID",
    s3_key: "S3Key", # required
  },
})

Response structure


resp.import_task.creation_date_time #=> String
resp.import_task.end_date_time #=> String
resp.import_task.import_id #=> String
resp.import_task.progress_percentage #=> Float
resp.import_task.s3_bucket_source.s3_bucket #=> String
resp.import_task.s3_bucket_source.s3_bucket_owner #=> String
resp.import_task.s3_bucket_source.s3_key #=> String
resp.import_task.status #=> String, one of "PENDING", "STARTED", "FAILED", "SUCCEEDED"
resp.import_task.summary.applications.created_count #=> Integer
resp.import_task.summary.applications.modified_count #=> Integer
resp.import_task.summary.servers.created_count #=> Integer
resp.import_task.summary.servers.modified_count #=> Integer
resp.import_task.summary.waves.created_count #=> Integer
resp.import_task.summary.waves.modified_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    Start import request client token.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :s3_bucket_source (required, Types::S3BucketSource) —

    Start import request s3 bucket source.

Returns:

See Also:



3808
3809
3810
3811
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 3808

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

#start_replication(params = {}) ⇒ Types::SourceServer

Starts replication for SNAPSHOT_SHIPPING agents.

Examples:

Request syntax with placeholder values


resp = client.start_replication({
  account_id: "AccountID",
  source_server_id: "SourceServerID", # required
})

Response structure


resp.application_id #=> String
resp.arn #=> String
resp.connector_action.connector_arn #=> String
resp.connector_action.credentials_secret_arn #=> String
resp.data_replication_info.data_replication_error.error #=> String, one of "AGENT_NOT_SEEN", "SNAPSHOTS_FAILURE", "NOT_CONVERGING", "UNSTABLE_NETWORK", "FAILED_TO_CREATE_SECURITY_GROUP", "FAILED_TO_LAUNCH_REPLICATION_SERVER", "FAILED_TO_BOOT_REPLICATION_SERVER", "FAILED_TO_AUTHENTICATE_WITH_SERVICE", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", "FAILED_TO_CREATE_STAGING_DISKS", "FAILED_TO_ATTACH_STAGING_DISKS", "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", "FAILED_TO_START_DATA_TRANSFER", "UNSUPPORTED_VM_CONFIGURATION", "LAST_SNAPSHOT_JOB_FAILED"
resp.data_replication_info.data_replication_error.raw_error #=> String
resp.data_replication_info.data_replication_initiation.next_attempt_date_time #=> String
resp.data_replication_info.data_replication_initiation.start_date_time #=> String
resp.data_replication_info.data_replication_initiation.steps #=> Array
resp.data_replication_info.data_replication_initiation.steps[0].name #=> String, one of "WAIT", "CREATE_SECURITY_GROUP", "LAUNCH_REPLICATION_SERVER", "BOOT_REPLICATION_SERVER", "AUTHENTICATE_WITH_SERVICE", "DOWNLOAD_REPLICATION_SOFTWARE", "CREATE_STAGING_DISKS", "ATTACH_STAGING_DISKS", "PAIR_REPLICATION_SERVER_WITH_AGENT", "CONNECT_AGENT_TO_REPLICATION_SERVER", "START_DATA_TRANSFER"
resp.data_replication_info.data_replication_initiation.steps[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "SKIPPED"
resp.data_replication_info.data_replication_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED", "PENDING_SNAPSHOT_SHIPPING", "SHIPPING_SNAPSHOT"
resp.data_replication_info.eta_date_time #=> String
resp.data_replication_info.lag_duration #=> String
resp.data_replication_info.last_snapshot_date_time #=> String
resp.data_replication_info.replicated_disks #=> Array
resp.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].device_name #=> String
resp.data_replication_info.replicated_disks[0].replicated_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].rescanned_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].total_storage_bytes #=> Integer
resp.fqdn_for_action_framework #=> String
resp.is_archived #=> Boolean
resp.launched_instance.ec2_instance_id #=> String
resp.launched_instance.first_boot #=> String, one of "WAITING", "SUCCEEDED", "UNKNOWN", "STOPPED"
resp.launched_instance.job_id #=> String
resp.life_cycle.added_to_service_date_time #=> String
resp.life_cycle.elapsed_replication_duration #=> String
resp.life_cycle.first_byte_date_time #=> String
resp.life_cycle.last_cutover.finalized.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.job_id #=> String
resp.life_cycle.last_cutover.reverted.api_call_date_time #=> String
resp.life_cycle.last_seen_by_service_date_time #=> String
resp.life_cycle.last_test.finalized.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.job_id #=> String
resp.life_cycle.last_test.reverted.api_call_date_time #=> String
resp.life_cycle.state #=> String, one of "STOPPED", "NOT_READY", "READY_FOR_TEST", "TESTING", "READY_FOR_CUTOVER", "CUTTING_OVER", "CUTOVER", "DISCONNECTED", "DISCOVERED", "PENDING_INSTALLATION"
resp.replication_type #=> String, one of "AGENT_BASED", "SNAPSHOT_SHIPPING"
resp.source_properties.cpus #=> Array
resp.source_properties.cpus[0].cores #=> Integer
resp.source_properties.cpus[0].model_name #=> String
resp.source_properties.disks #=> Array
resp.source_properties.disks[0].bytes #=> Integer
resp.source_properties.disks[0].device_name #=> String
resp.source_properties.identification_hints.aws_instance_id #=> String
resp.source_properties.identification_hints.fqdn #=> String
resp.source_properties.identification_hints.hostname #=> String
resp.source_properties.identification_hints.vm_path #=> String
resp.source_properties.identification_hints.vm_ware_uuid #=> String
resp.source_properties.last_updated_date_time #=> String
resp.source_properties.network_interfaces #=> Array
resp.source_properties.network_interfaces[0].ips #=> Array
resp.source_properties.network_interfaces[0].ips[0] #=> String
resp.source_properties.network_interfaces[0].is_primary #=> Boolean
resp.source_properties.network_interfaces[0].mac_address #=> String
resp.source_properties.os.full_string #=> String
resp.source_properties.ram_bytes #=> Integer
resp.source_properties.recommended_instance_type #=> String
resp.source_server_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.user_provided_id #=> String
resp.vcenter_client_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Account ID on which to start replication.

  • :source_server_id (required, String) —

    ID of source server on which to start replication.

Returns:

See Also:



3917
3918
3919
3920
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 3917

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

#start_test(params = {}) ⇒ Types::StartTestResponse

Launches a Test Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartTest and changes the SourceServer.lifeCycle.state property to TESTING.

Examples:

Request syntax with placeholder values


resp = client.start_test({
  account_id: "AccountID",
  source_server_i_ds: ["SourceServerID"], # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.job.arn #=> String
resp.job.creation_date_time #=> String
resp.job.end_date_time #=> String
resp.job.initiated_by #=> String, one of "START_TEST", "START_CUTOVER", "DIAGNOSTIC", "TERMINATE"
resp.job.job_id #=> String
resp.job.participating_servers #=> Array
resp.job.participating_servers[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.job.participating_servers[0].launched_ec2_instance_id #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list #=> Array
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].execution_id #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].execution_status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].failure_reason #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.action_name #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.external_parameters #=> Hash
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.external_parameters["SsmDocumentParameterName"].dynamic_path #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.must_succeed_for_cutover #=> Boolean
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.parameters #=> Hash
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.parameters["SsmDocumentParameterName"] #=> Array
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.parameters["SsmDocumentParameterName"][0].parameter_name #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.parameters["SsmDocumentParameterName"][0].parameter_type #=> String, one of "STRING"
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.ssm_document_name #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.timeout_seconds #=> Integer
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document_type #=> String, one of "AUTOMATION", "COMMAND"
resp.job.participating_servers[0].post_launch_actions_status.ssm_agent_discovery_datetime #=> String
resp.job.participating_servers[0].source_server_id #=> String
resp.job.status #=> String, one of "PENDING", "STARTED", "COMPLETED"
resp.job.tags #=> Hash
resp.job.tags["TagKey"] #=> String
resp.job.type #=> String, one of "LAUNCH", "TERMINATE"

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Start Test for Account ID.

  • :source_server_i_ds (required, Array<String>) —

    Start Test for Source Server IDs.

  • :tags (Hash<String,String>) —

    Start Test by Tags.

Returns:

See Also:



3985
3986
3987
3988
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 3985

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

#stop_replication(params = {}) ⇒ Types::SourceServer

Stop Replication.

Examples:

Request syntax with placeholder values


resp = client.stop_replication({
  account_id: "AccountID",
  source_server_id: "SourceServerID", # required
})

Response structure


resp.application_id #=> String
resp.arn #=> String
resp.connector_action.connector_arn #=> String
resp.connector_action.credentials_secret_arn #=> String
resp.data_replication_info.data_replication_error.error #=> String, one of "AGENT_NOT_SEEN", "SNAPSHOTS_FAILURE", "NOT_CONVERGING", "UNSTABLE_NETWORK", "FAILED_TO_CREATE_SECURITY_GROUP", "FAILED_TO_LAUNCH_REPLICATION_SERVER", "FAILED_TO_BOOT_REPLICATION_SERVER", "FAILED_TO_AUTHENTICATE_WITH_SERVICE", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", "FAILED_TO_CREATE_STAGING_DISKS", "FAILED_TO_ATTACH_STAGING_DISKS", "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", "FAILED_TO_START_DATA_TRANSFER", "UNSUPPORTED_VM_CONFIGURATION", "LAST_SNAPSHOT_JOB_FAILED"
resp.data_replication_info.data_replication_error.raw_error #=> String
resp.data_replication_info.data_replication_initiation.next_attempt_date_time #=> String
resp.data_replication_info.data_replication_initiation.start_date_time #=> String
resp.data_replication_info.data_replication_initiation.steps #=> Array
resp.data_replication_info.data_replication_initiation.steps[0].name #=> String, one of "WAIT", "CREATE_SECURITY_GROUP", "LAUNCH_REPLICATION_SERVER", "BOOT_REPLICATION_SERVER", "AUTHENTICATE_WITH_SERVICE", "DOWNLOAD_REPLICATION_SOFTWARE", "CREATE_STAGING_DISKS", "ATTACH_STAGING_DISKS", "PAIR_REPLICATION_SERVER_WITH_AGENT", "CONNECT_AGENT_TO_REPLICATION_SERVER", "START_DATA_TRANSFER"
resp.data_replication_info.data_replication_initiation.steps[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "SKIPPED"
resp.data_replication_info.data_replication_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED", "PENDING_SNAPSHOT_SHIPPING", "SHIPPING_SNAPSHOT"
resp.data_replication_info.eta_date_time #=> String
resp.data_replication_info.lag_duration #=> String
resp.data_replication_info.last_snapshot_date_time #=> String
resp.data_replication_info.replicated_disks #=> Array
resp.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].device_name #=> String
resp.data_replication_info.replicated_disks[0].replicated_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].rescanned_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].total_storage_bytes #=> Integer
resp.fqdn_for_action_framework #=> String
resp.is_archived #=> Boolean
resp.launched_instance.ec2_instance_id #=> String
resp.launched_instance.first_boot #=> String, one of "WAITING", "SUCCEEDED", "UNKNOWN", "STOPPED"
resp.launched_instance.job_id #=> String
resp.life_cycle.added_to_service_date_time #=> String
resp.life_cycle.elapsed_replication_duration #=> String
resp.life_cycle.first_byte_date_time #=> String
resp.life_cycle.last_cutover.finalized.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.job_id #=> String
resp.life_cycle.last_cutover.reverted.api_call_date_time #=> String
resp.life_cycle.last_seen_by_service_date_time #=> String
resp.life_cycle.last_test.finalized.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.job_id #=> String
resp.life_cycle.last_test.reverted.api_call_date_time #=> String
resp.life_cycle.state #=> String, one of "STOPPED", "NOT_READY", "READY_FOR_TEST", "TESTING", "READY_FOR_CUTOVER", "CUTTING_OVER", "CUTOVER", "DISCONNECTED", "DISCOVERED", "PENDING_INSTALLATION"
resp.replication_type #=> String, one of "AGENT_BASED", "SNAPSHOT_SHIPPING"
resp.source_properties.cpus #=> Array
resp.source_properties.cpus[0].cores #=> Integer
resp.source_properties.cpus[0].model_name #=> String
resp.source_properties.disks #=> Array
resp.source_properties.disks[0].bytes #=> Integer
resp.source_properties.disks[0].device_name #=> String
resp.source_properties.identification_hints.aws_instance_id #=> String
resp.source_properties.identification_hints.fqdn #=> String
resp.source_properties.identification_hints.hostname #=> String
resp.source_properties.identification_hints.vm_path #=> String
resp.source_properties.identification_hints.vm_ware_uuid #=> String
resp.source_properties.last_updated_date_time #=> String
resp.source_properties.network_interfaces #=> Array
resp.source_properties.network_interfaces[0].ips #=> Array
resp.source_properties.network_interfaces[0].ips[0] #=> String
resp.source_properties.network_interfaces[0].is_primary #=> Boolean
resp.source_properties.network_interfaces[0].mac_address #=> String
resp.source_properties.os.full_string #=> String
resp.source_properties.ram_bytes #=> Integer
resp.source_properties.recommended_instance_type #=> String
resp.source_server_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.user_provided_id #=> String
resp.vcenter_client_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Stop Replication Request account ID.

  • :source_server_id (required, String) —

    Stop Replication Request source server ID.

Returns:

See Also:



4094
4095
4096
4097
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 4094

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

#tag_resource(params = {}) ⇒ Struct

Adds or overwrites only the specified tags for the specified Application Migration Service resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ARN", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Tag resource by ARN.

  • :tags (required, Hash<String,String>) —

    Tag resource by Tags.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4126
4127
4128
4129
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 4126

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

#terminate_target_instances(params = {}) ⇒ Types::TerminateTargetInstancesResponse

Starts a job that terminates specific launched EC2 Test and Cutover instances. This command will not work for any Source Server with a lifecycle.state of TESTING, CUTTING_OVER, or CUTOVER.

Examples:

Request syntax with placeholder values


resp = client.terminate_target_instances({
  account_id: "AccountID",
  source_server_i_ds: ["SourceServerID"], # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.job.arn #=> String
resp.job.creation_date_time #=> String
resp.job.end_date_time #=> String
resp.job.initiated_by #=> String, one of "START_TEST", "START_CUTOVER", "DIAGNOSTIC", "TERMINATE"
resp.job.job_id #=> String
resp.job.participating_servers #=> Array
resp.job.participating_servers[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.job.participating_servers[0].launched_ec2_instance_id #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list #=> Array
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].execution_id #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].execution_status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].failure_reason #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.action_name #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.external_parameters #=> Hash
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.external_parameters["SsmDocumentParameterName"].dynamic_path #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.must_succeed_for_cutover #=> Boolean
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.parameters #=> Hash
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.parameters["SsmDocumentParameterName"] #=> Array
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.parameters["SsmDocumentParameterName"][0].parameter_name #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.parameters["SsmDocumentParameterName"][0].parameter_type #=> String, one of "STRING"
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.ssm_document_name #=> String
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document.timeout_seconds #=> Integer
resp.job.participating_servers[0].post_launch_actions_status.post_launch_actions_launch_status_list[0].ssm_document_type #=> String, one of "AUTOMATION", "COMMAND"
resp.job.participating_servers[0].post_launch_actions_status.ssm_agent_discovery_datetime #=> String
resp.job.participating_servers[0].source_server_id #=> String
resp.job.status #=> String, one of "PENDING", "STARTED", "COMPLETED"
resp.job.tags #=> Hash
resp.job.tags["TagKey"] #=> String
resp.job.type #=> String, one of "LAUNCH", "TERMINATE"

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Terminate Target instance by Account ID

  • :source_server_i_ds (required, Array<String>) —

    Terminate Target instance by Source Server IDs.

  • :tags (Hash<String,String>) —

    Terminate Target instance by Tags.

Returns:

See Also:



4194
4195
4196
4197
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 4194

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

#unarchive_application(params = {}) ⇒ Types::Application

Unarchive application.

Examples:

Request syntax with placeholder values


resp = client.unarchive_application({
  account_id: "AccountID",
  application_id: "ApplicationID", # required
})

Response structure


resp.application_aggregated_status.health_status #=> String, one of "HEALTHY", "LAGGING", "ERROR"
resp.application_aggregated_status.last_update_date_time #=> String
resp.application_aggregated_status.progress_status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED"
resp.application_aggregated_status.total_source_servers #=> Integer
resp.application_id #=> String
resp.arn #=> String
resp.creation_date_time #=> String
resp.description #=> String
resp.is_archived #=> Boolean
resp.last_modified_date_time #=> String
resp.name #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.wave_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Account ID.

  • :application_id (required, String) —

    Application ID.

Returns:

See Also:



4248
4249
4250
4251
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 4248

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

#unarchive_wave(params = {}) ⇒ Types::Wave

Unarchive wave.

Examples:

Request syntax with placeholder values


resp = client.unarchive_wave({
  account_id: "AccountID",
  wave_id: "WaveID", # required
})

Response structure


resp.arn #=> String
resp.creation_date_time #=> String
resp.description #=> String
resp.is_archived #=> Boolean
resp.last_modified_date_time #=> String
resp.name #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.wave_aggregated_status.health_status #=> String, one of "HEALTHY", "LAGGING", "ERROR"
resp.wave_aggregated_status.last_update_date_time #=> String
resp.wave_aggregated_status.progress_status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED"
resp.wave_aggregated_status.replication_started_date_time #=> String
resp.wave_aggregated_status.total_applications #=> Integer
resp.wave_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Account ID.

  • :wave_id (required, String) —

    Wave ID.

Returns:

See Also:



4301
4302
4303
4304
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 4301

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

#untag_resource(params = {}) ⇒ Struct

Deletes the specified set of tags from the specified set of Application Migration Service resources.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ARN", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Untag resource by ARN.

  • :tag_keys (required, Array<String>) —

    Untag resource by Keys.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4328
4329
4330
4331
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 4328

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

#update_application(params = {}) ⇒ Types::Application

Update application.

Examples:

Request syntax with placeholder values


resp = client.update_application({
  account_id: "AccountID",
  application_id: "ApplicationID", # required
  description: "ApplicationDescription",
  name: "ApplicationName",
})

Response structure


resp.application_aggregated_status.health_status #=> String, one of "HEALTHY", "LAGGING", "ERROR"
resp.application_aggregated_status.last_update_date_time #=> String
resp.application_aggregated_status.progress_status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED"
resp.application_aggregated_status.total_source_servers #=> Integer
resp.application_id #=> String
resp.arn #=> String
resp.creation_date_time #=> String
resp.description #=> String
resp.is_archived #=> Boolean
resp.last_modified_date_time #=> String
resp.name #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.wave_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Account ID.

  • :application_id (required, String) —

    Application ID.

  • :description (String) —

    Application description.

  • :name (String) —

    Application name.

Returns:

See Also:



4390
4391
4392
4393
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 4390

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

#update_connector(params = {}) ⇒ Types::Connector

Update Connector.

Examples:

Request syntax with placeholder values


resp = client.update_connector({
  connector_id: "ConnectorID", # required
  name: "ConnectorName",
  ssm_command_config: {
    cloud_watch_log_group_name: "CloudWatchLogGroupName",
    cloud_watch_output_enabled: false, # required
    output_s3_bucket_name: "S3BucketName",
    s3_output_enabled: false, # required
  },
})

Response structure


resp.arn #=> String
resp.connector_id #=> String
resp.name #=> String
resp.ssm_command_config.cloud_watch_log_group_name #=> String
resp.ssm_command_config.cloud_watch_output_enabled #=> Boolean
resp.ssm_command_config.output_s3_bucket_name #=> String
resp.ssm_command_config.s3_output_enabled #=> Boolean
resp.ssm_instance_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connector_id (required, String) —

    Update Connector request connector ID.

  • :name (String) —

    Update Connector request name.

  • :ssm_command_config (Types::ConnectorSsmCommandConfig) —

    Update Connector request SSM command config.

Returns:

See Also:



4445
4446
4447
4448
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 4445

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

#update_launch_configuration(params = {}) ⇒ Types::LaunchConfiguration

Updates multiple LaunchConfigurations by Source Server ID.

bootMode valid values are LEGACY_BIOS | UEFI

Examples:

Request syntax with placeholder values


resp = client.update_launch_configuration({
  account_id: "AccountID",
  boot_mode: "LEGACY_BIOS", # accepts LEGACY_BIOS, UEFI, USE_SOURCE
  copy_private_ip: false,
  copy_tags: false,
  enable_map_auto_tagging: false,
  launch_disposition: "STOPPED", # accepts STOPPED, STARTED
  licensing: {
    os_byol: false,
  },
  map_auto_tagging_mpe_id: "TagValue",
  name: "SmallBoundedString",
  post_launch_actions: {
    cloud_watch_log_group_name: "CloudWatchLogGroupName",
    deployment: "TEST_AND_CUTOVER", # accepts TEST_AND_CUTOVER, CUTOVER_ONLY, TEST_ONLY
    s3_log_bucket: "S3LogBucketName",
    s3_output_key_prefix: "BoundedString",
    ssm_documents: [
      {
        action_name: "BoundedString", # required
        external_parameters: {
          "SsmDocumentParameterName" => {
            dynamic_path: "JmesPathString",
          },
        },
        must_succeed_for_cutover: false,
        parameters: {
          "SsmDocumentParameterName" => [
            {
              parameter_name: "SsmParameterStoreParameterName", # required
              parameter_type: "STRING", # required, accepts STRING
            },
          ],
        },
        ssm_document_name: "SsmDocumentName", # required
        timeout_seconds: 1,
      },
    ],
  },
  source_server_id: "SourceServerID", # required
  target_instance_type_right_sizing_method: "NONE", # accepts NONE, BASIC
})

Response structure


resp.boot_mode #=> String, one of "LEGACY_BIOS", "UEFI", "USE_SOURCE"
resp.copy_private_ip #=> Boolean
resp.copy_tags #=> Boolean
resp.ec2_launch_template_id #=> String
resp.enable_map_auto_tagging #=> Boolean
resp.launch_disposition #=> String, one of "STOPPED", "STARTED"
resp.licensing.os_byol #=> Boolean
resp.map_auto_tagging_mpe_id #=> String
resp.name #=> String
resp.post_launch_actions.cloud_watch_log_group_name #=> String
resp.post_launch_actions.deployment #=> String, one of "TEST_AND_CUTOVER", "CUTOVER_ONLY", "TEST_ONLY"
resp.post_launch_actions.s3_log_bucket #=> String
resp.post_launch_actions.s3_output_key_prefix #=> String
resp.post_launch_actions.ssm_documents #=> Array
resp.post_launch_actions.ssm_documents[0].action_name #=> String
resp.post_launch_actions.ssm_documents[0].external_parameters #=> Hash
resp.post_launch_actions.ssm_documents[0].external_parameters["SsmDocumentParameterName"].dynamic_path #=> String
resp.post_launch_actions.ssm_documents[0].must_succeed_for_cutover #=> Boolean
resp.post_launch_actions.ssm_documents[0].parameters #=> Hash
resp.post_launch_actions.ssm_documents[0].parameters["SsmDocumentParameterName"] #=> Array
resp.post_launch_actions.ssm_documents[0].parameters["SsmDocumentParameterName"][0].parameter_name #=> String
resp.post_launch_actions.ssm_documents[0].parameters["SsmDocumentParameterName"][0].parameter_type #=> String, one of "STRING"
resp.post_launch_actions.ssm_documents[0].ssm_document_name #=> String
resp.post_launch_actions.ssm_documents[0].timeout_seconds #=> Integer
resp.source_server_id #=> String
resp.target_instance_type_right_sizing_method #=> String, one of "NONE", "BASIC"

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Update Launch configuration Account ID.

  • :boot_mode (String) —

    Update Launch configuration boot mode request.

  • :copy_private_ip (Boolean) —

    Update Launch configuration copy Private IP request.

  • :copy_tags (Boolean) —

    Update Launch configuration copy Tags request.

  • :enable_map_auto_tagging (Boolean) —

    Enable map auto tagging.

  • :launch_disposition (String) —

    Update Launch configuration launch disposition request.

  • :licensing (Types::Licensing) —

    Update Launch configuration licensing request.

  • :map_auto_tagging_mpe_id (String) —

    Launch configuration map auto tagging MPE ID.

  • :name (String) —

    Update Launch configuration name request.

  • :post_launch_actions (Types::PostLaunchActions) —

    Post Launch Actions to executed on the Test or Cutover instance.

  • :source_server_id (required, String) —

    Update Launch configuration by Source Server ID request.

  • :target_instance_type_right_sizing_method (String) —

    Update Launch configuration Target instance right sizing request.

Returns:

See Also:



4585
4586
4587
4588
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 4585

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

#update_launch_configuration_template(params = {}) ⇒ Types::LaunchConfigurationTemplate

Updates an existing Launch Configuration Template by ID.

Examples:

Request syntax with placeholder values


resp = client.update_launch_configuration_template({
  associate_public_ip_address: false,
  boot_mode: "LEGACY_BIOS", # accepts LEGACY_BIOS, UEFI, USE_SOURCE
  copy_private_ip: false,
  copy_tags: false,
  enable_map_auto_tagging: false,
  large_volume_conf: {
    iops: 1,
    throughput: 1,
    volume_type: "io1", # accepts io1, io2, gp3, gp2, st1, sc1, standard
  },
  launch_configuration_template_id: "LaunchConfigurationTemplateID", # required
  launch_disposition: "STOPPED", # accepts STOPPED, STARTED
  licensing: {
    os_byol: false,
  },
  map_auto_tagging_mpe_id: "TagValue",
  post_launch_actions: {
    cloud_watch_log_group_name: "CloudWatchLogGroupName",
    deployment: "TEST_AND_CUTOVER", # accepts TEST_AND_CUTOVER, CUTOVER_ONLY, TEST_ONLY
    s3_log_bucket: "S3LogBucketName",
    s3_output_key_prefix: "BoundedString",
    ssm_documents: [
      {
        action_name: "BoundedString", # required
        external_parameters: {
          "SsmDocumentParameterName" => {
            dynamic_path: "JmesPathString",
          },
        },
        must_succeed_for_cutover: false,
        parameters: {
          "SsmDocumentParameterName" => [
            {
              parameter_name: "SsmParameterStoreParameterName", # required
              parameter_type: "STRING", # required, accepts STRING
            },
          ],
        },
        ssm_document_name: "SsmDocumentName", # required
        timeout_seconds: 1,
      },
    ],
  },
  small_volume_conf: {
    iops: 1,
    throughput: 1,
    volume_type: "io1", # accepts io1, io2, gp3, gp2, st1, sc1, standard
  },
  small_volume_max_size: 1,
  target_instance_type_right_sizing_method: "NONE", # accepts NONE, BASIC
})

Response structure


resp.arn #=> String
resp.associate_public_ip_address #=> Boolean
resp.boot_mode #=> String, one of "LEGACY_BIOS", "UEFI", "USE_SOURCE"
resp.copy_private_ip #=> Boolean
resp.copy_tags #=> Boolean
resp.ec2_launch_template_id #=> String
resp.enable_map_auto_tagging #=> Boolean
resp.large_volume_conf.iops #=> Integer
resp.large_volume_conf.throughput #=> Integer
resp.large_volume_conf.volume_type #=> String, one of "io1", "io2", "gp3", "gp2", "st1", "sc1", "standard"
resp.launch_configuration_template_id #=> String
resp.launch_disposition #=> String, one of "STOPPED", "STARTED"
resp.licensing.os_byol #=> Boolean
resp.map_auto_tagging_mpe_id #=> String
resp.post_launch_actions.cloud_watch_log_group_name #=> String
resp.post_launch_actions.deployment #=> String, one of "TEST_AND_CUTOVER", "CUTOVER_ONLY", "TEST_ONLY"
resp.post_launch_actions.s3_log_bucket #=> String
resp.post_launch_actions.s3_output_key_prefix #=> String
resp.post_launch_actions.ssm_documents #=> Array
resp.post_launch_actions.ssm_documents[0].action_name #=> String
resp.post_launch_actions.ssm_documents[0].external_parameters #=> Hash
resp.post_launch_actions.ssm_documents[0].external_parameters["SsmDocumentParameterName"].dynamic_path #=> String
resp.post_launch_actions.ssm_documents[0].must_succeed_for_cutover #=> Boolean
resp.post_launch_actions.ssm_documents[0].parameters #=> Hash
resp.post_launch_actions.ssm_documents[0].parameters["SsmDocumentParameterName"] #=> Array
resp.post_launch_actions.ssm_documents[0].parameters["SsmDocumentParameterName"][0].parameter_name #=> String
resp.post_launch_actions.ssm_documents[0].parameters["SsmDocumentParameterName"][0].parameter_type #=> String, one of "STRING"
resp.post_launch_actions.ssm_documents[0].ssm_document_name #=> String
resp.post_launch_actions.ssm_documents[0].timeout_seconds #=> Integer
resp.small_volume_conf.iops #=> Integer
resp.small_volume_conf.throughput #=> Integer
resp.small_volume_conf.volume_type #=> String, one of "io1", "io2", "gp3", "gp2", "st1", "sc1", "standard"
resp.small_volume_max_size #=> Integer
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.target_instance_type_right_sizing_method #=> String, one of "NONE", "BASIC"

Parameters:

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

    ({})

Options Hash (params):

  • :associate_public_ip_address (Boolean) —

    Associate public Ip address.

  • :boot_mode (String) —

    Launch configuration template boot mode.

  • :copy_private_ip (Boolean) —

    Copy private Ip.

  • :copy_tags (Boolean) —

    Copy tags.

  • :enable_map_auto_tagging (Boolean) —

    Enable map auto tagging.

  • :large_volume_conf (Types::LaunchTemplateDiskConf) —

    Large volume config.

  • :launch_configuration_template_id (required, String) —

    Launch Configuration Template ID.

  • :launch_disposition (String) —

    Launch disposition.

  • :licensing (Types::Licensing) —

    Configure Licensing.

  • :map_auto_tagging_mpe_id (String) —

    Launch configuration template map auto tagging MPE ID.

  • :post_launch_actions (Types::PostLaunchActions) —

    Post Launch Action to execute on the Test or Cutover instance.

  • :small_volume_conf (Types::LaunchTemplateDiskConf) —

    Small volume config.

  • :small_volume_max_size (Integer) —

    Small volume maximum size.

  • :target_instance_type_right_sizing_method (String) —

    Target instance type right-sizing method.

Returns:

See Also:



4752
4753
4754
4755
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 4752

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

#update_replication_configuration(params = {}) ⇒ Types::ReplicationConfiguration

Allows you to update multiple ReplicationConfigurations by Source Server ID.

Examples:

Request syntax with placeholder values


resp = client.update_replication_configuration({
  account_id: "AccountID",
  associate_default_security_group: false,
  bandwidth_throttling: 1,
  create_public_ip: false,
  data_plane_routing: "PRIVATE_IP", # accepts PRIVATE_IP, PUBLIC_IP
  default_large_staging_disk_type: "GP2", # accepts GP2, ST1, GP3
  ebs_encryption: "DEFAULT", # accepts DEFAULT, CUSTOM
  ebs_encryption_key_arn: "ARN",
  name: "SmallBoundedString",
  replicated_disks: [
    {
      device_name: "BoundedString",
      iops: 1,
      is_boot_disk: false,
      staging_disk_type: "AUTO", # accepts AUTO, GP2, IO1, SC1, ST1, STANDARD, GP3, IO2
      throughput: 1,
    },
  ],
  replication_server_instance_type: "EC2InstanceType",
  replication_servers_security_groups_i_ds: ["SecurityGroupID"],
  source_server_id: "SourceServerID", # required
  staging_area_subnet_id: "SubnetID",
  staging_area_tags: {
    "TagKey" => "TagValue",
  },
  use_dedicated_replication_server: false,
  use_fips_endpoint: false,
})

Response structure


resp.associate_default_security_group #=> Boolean
resp.bandwidth_throttling #=> Integer
resp.create_public_ip #=> Boolean
resp.data_plane_routing #=> String, one of "PRIVATE_IP", "PUBLIC_IP"
resp.default_large_staging_disk_type #=> String, one of "GP2", "ST1", "GP3"
resp.ebs_encryption #=> String, one of "DEFAULT", "CUSTOM"
resp.ebs_encryption_key_arn #=> String
resp.name #=> String
resp.replicated_disks #=> Array
resp.replicated_disks[0].device_name #=> String
resp.replicated_disks[0].iops #=> Integer
resp.replicated_disks[0].is_boot_disk #=> Boolean
resp.replicated_disks[0].staging_disk_type #=> String, one of "AUTO", "GP2", "IO1", "SC1", "ST1", "STANDARD", "GP3", "IO2"
resp.replicated_disks[0].throughput #=> Integer
resp.replication_server_instance_type #=> String
resp.replication_servers_security_groups_i_ds #=> Array
resp.replication_servers_security_groups_i_ds[0] #=> String
resp.source_server_id #=> String
resp.staging_area_subnet_id #=> String
resp.staging_area_tags #=> Hash
resp.staging_area_tags["TagKey"] #=> String
resp.use_dedicated_replication_server #=> Boolean
resp.use_fips_endpoint #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Update replication configuration Account ID request.

  • :associate_default_security_group (Boolean) —

    Update replication configuration associate default Application Migration Service Security group request.

  • :bandwidth_throttling (Integer) —

    Update replication configuration bandwidth throttling request.

  • :create_public_ip (Boolean) —

    Update replication configuration create Public IP request.

  • :data_plane_routing (String) —

    Update replication configuration data plane routing request.

  • :default_large_staging_disk_type (String) —

    Update replication configuration use default large Staging Disk type request.

  • :ebs_encryption (String) —

    Update replication configuration EBS encryption request.

  • :ebs_encryption_key_arn (String) —

    Update replication configuration EBS encryption key ARN request.

  • :name (String) —

    Update replication configuration name request.

  • :replicated_disks (Array<Types::ReplicationConfigurationReplicatedDisk>) —

    Update replication configuration replicated disks request.

  • :replication_server_instance_type (String) —

    Update replication configuration Replication Server instance type request.

  • :replication_servers_security_groups_i_ds (Array<String>) —

    Update replication configuration Replication Server Security Groups IDs request.

  • :source_server_id (required, String) —

    Update replication configuration Source Server ID request.

  • :staging_area_subnet_id (String) —

    Update replication configuration Staging Area subnet request.

  • :staging_area_tags (Hash<String,String>) —

    Update replication configuration Staging Area Tags request.

  • :use_dedicated_replication_server (Boolean) —

    Update replication configuration use dedicated Replication Server request.

  • :use_fips_endpoint (Boolean) —

    Update replication configuration use Fips Endpoint.

Returns:

See Also:



4897
4898
4899
4900
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 4897

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

#update_replication_configuration_template(params = {}) ⇒ Types::ReplicationConfigurationTemplate

Updates multiple ReplicationConfigurationTemplates by ID.

Examples:

Request syntax with placeholder values


resp = client.update_replication_configuration_template({
  arn: "ARN",
  associate_default_security_group: false,
  bandwidth_throttling: 1,
  create_public_ip: false,
  data_plane_routing: "PRIVATE_IP", # accepts PRIVATE_IP, PUBLIC_IP
  default_large_staging_disk_type: "GP2", # accepts GP2, ST1, GP3
  ebs_encryption: "DEFAULT", # accepts DEFAULT, CUSTOM
  ebs_encryption_key_arn: "ARN",
  replication_configuration_template_id: "ReplicationConfigurationTemplateID", # required
  replication_server_instance_type: "EC2InstanceType",
  replication_servers_security_groups_i_ds: ["SecurityGroupID"],
  staging_area_subnet_id: "SubnetID",
  staging_area_tags: {
    "TagKey" => "TagValue",
  },
  use_dedicated_replication_server: false,
  use_fips_endpoint: false,
})

Response structure


resp.arn #=> String
resp.associate_default_security_group #=> Boolean
resp.bandwidth_throttling #=> Integer
resp.create_public_ip #=> Boolean
resp.data_plane_routing #=> String, one of "PRIVATE_IP", "PUBLIC_IP"
resp.default_large_staging_disk_type #=> String, one of "GP2", "ST1", "GP3"
resp.ebs_encryption #=> String, one of "DEFAULT", "CUSTOM"
resp.ebs_encryption_key_arn #=> String
resp.replication_configuration_template_id #=> String
resp.replication_server_instance_type #=> String
resp.replication_servers_security_groups_i_ds #=> Array
resp.replication_servers_security_groups_i_ds[0] #=> String
resp.staging_area_subnet_id #=> String
resp.staging_area_tags #=> Hash
resp.staging_area_tags["TagKey"] #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.use_dedicated_replication_server #=> Boolean
resp.use_fips_endpoint #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :arn (String) —

    Update replication configuration template ARN request.

  • :associate_default_security_group (Boolean) —

    Update replication configuration template associate default Application Migration Service Security group request.

  • :bandwidth_throttling (Integer) —

    Update replication configuration template bandwidth throttling request.

  • :create_public_ip (Boolean) —

    Update replication configuration template create Public IP request.

  • :data_plane_routing (String) —

    Update replication configuration template data plane routing request.

  • :default_large_staging_disk_type (String) —

    Update replication configuration template use default large Staging Disk type request.

  • :ebs_encryption (String) —

    Update replication configuration template EBS encryption request.

  • :ebs_encryption_key_arn (String) —

    Update replication configuration template EBS encryption key ARN request.

  • :replication_configuration_template_id (required, String) —

    Update replication configuration template template ID request.

  • :replication_server_instance_type (String) —

    Update replication configuration template Replication Server instance type request.

  • :replication_servers_security_groups_i_ds (Array<String>) —

    Update replication configuration template Replication Server Security groups IDs request.

  • :staging_area_subnet_id (String) —

    Update replication configuration template Staging Area subnet ID request.

  • :staging_area_tags (Hash<String,String>) —

    Update replication configuration template Staging Area Tags request.

  • :use_dedicated_replication_server (Boolean) —

    Update replication configuration template use dedicated Replication Server request.

  • :use_fips_endpoint (Boolean) —

    Update replication configuration template use Fips Endpoint request.

Returns:

See Also:



5024
5025
5026
5027
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 5024

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

#update_source_server(params = {}) ⇒ Types::SourceServer

Update Source Server.

Examples:

Request syntax with placeholder values


resp = client.update_source_server({
  account_id: "AccountID",
  connector_action: {
    connector_arn: "ConnectorArn",
    credentials_secret_arn: "SecretArn",
  },
  source_server_id: "SourceServerID", # required
})

Response structure


resp.application_id #=> String
resp.arn #=> String
resp.connector_action.connector_arn #=> String
resp.connector_action.credentials_secret_arn #=> String
resp.data_replication_info.data_replication_error.error #=> String, one of "AGENT_NOT_SEEN", "SNAPSHOTS_FAILURE", "NOT_CONVERGING", "UNSTABLE_NETWORK", "FAILED_TO_CREATE_SECURITY_GROUP", "FAILED_TO_LAUNCH_REPLICATION_SERVER", "FAILED_TO_BOOT_REPLICATION_SERVER", "FAILED_TO_AUTHENTICATE_WITH_SERVICE", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", "FAILED_TO_CREATE_STAGING_DISKS", "FAILED_TO_ATTACH_STAGING_DISKS", "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", "FAILED_TO_START_DATA_TRANSFER", "UNSUPPORTED_VM_CONFIGURATION", "LAST_SNAPSHOT_JOB_FAILED"
resp.data_replication_info.data_replication_error.raw_error #=> String
resp.data_replication_info.data_replication_initiation.next_attempt_date_time #=> String
resp.data_replication_info.data_replication_initiation.start_date_time #=> String
resp.data_replication_info.data_replication_initiation.steps #=> Array
resp.data_replication_info.data_replication_initiation.steps[0].name #=> String, one of "WAIT", "CREATE_SECURITY_GROUP", "LAUNCH_REPLICATION_SERVER", "BOOT_REPLICATION_SERVER", "AUTHENTICATE_WITH_SERVICE", "DOWNLOAD_REPLICATION_SOFTWARE", "CREATE_STAGING_DISKS", "ATTACH_STAGING_DISKS", "PAIR_REPLICATION_SERVER_WITH_AGENT", "CONNECT_AGENT_TO_REPLICATION_SERVER", "START_DATA_TRANSFER"
resp.data_replication_info.data_replication_initiation.steps[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "SKIPPED"
resp.data_replication_info.data_replication_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED", "PENDING_SNAPSHOT_SHIPPING", "SHIPPING_SNAPSHOT"
resp.data_replication_info.eta_date_time #=> String
resp.data_replication_info.lag_duration #=> String
resp.data_replication_info.last_snapshot_date_time #=> String
resp.data_replication_info.replicated_disks #=> Array
resp.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].device_name #=> String
resp.data_replication_info.replicated_disks[0].replicated_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].rescanned_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].total_storage_bytes #=> Integer
resp.fqdn_for_action_framework #=> String
resp.is_archived #=> Boolean
resp.launched_instance.ec2_instance_id #=> String
resp.launched_instance.first_boot #=> String, one of "WAITING", "SUCCEEDED", "UNKNOWN", "STOPPED"
resp.launched_instance.job_id #=> String
resp.life_cycle.added_to_service_date_time #=> String
resp.life_cycle.elapsed_replication_duration #=> String
resp.life_cycle.first_byte_date_time #=> String
resp.life_cycle.last_cutover.finalized.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.job_id #=> String
resp.life_cycle.last_cutover.reverted.api_call_date_time #=> String
resp.life_cycle.last_seen_by_service_date_time #=> String
resp.life_cycle.last_test.finalized.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.job_id #=> String
resp.life_cycle.last_test.reverted.api_call_date_time #=> String
resp.life_cycle.state #=> String, one of "STOPPED", "NOT_READY", "READY_FOR_TEST", "TESTING", "READY_FOR_CUTOVER", "CUTTING_OVER", "CUTOVER", "DISCONNECTED", "DISCOVERED", "PENDING_INSTALLATION"
resp.replication_type #=> String, one of "AGENT_BASED", "SNAPSHOT_SHIPPING"
resp.source_properties.cpus #=> Array
resp.source_properties.cpus[0].cores #=> Integer
resp.source_properties.cpus[0].model_name #=> String
resp.source_properties.disks #=> Array
resp.source_properties.disks[0].bytes #=> Integer
resp.source_properties.disks[0].device_name #=> String
resp.source_properties.identification_hints.aws_instance_id #=> String
resp.source_properties.identification_hints.fqdn #=> String
resp.source_properties.identification_hints.hostname #=> String
resp.source_properties.identification_hints.vm_path #=> String
resp.source_properties.identification_hints.vm_ware_uuid #=> String
resp.source_properties.last_updated_date_time #=> String
resp.source_properties.network_interfaces #=> Array
resp.source_properties.network_interfaces[0].ips #=> Array
resp.source_properties.network_interfaces[0].ips[0] #=> String
resp.source_properties.network_interfaces[0].is_primary #=> Boolean
resp.source_properties.network_interfaces[0].mac_address #=> String
resp.source_properties.os.full_string #=> String
resp.source_properties.ram_bytes #=> Integer
resp.source_properties.recommended_instance_type #=> String
resp.source_server_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.user_provided_id #=> String
resp.vcenter_client_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Update Source Server request account ID.

  • :connector_action (Types::SourceServerConnectorAction) —

    Update Source Server request connector action.

  • :source_server_id (required, String) —

    Update Source Server request source server ID.

Returns:

See Also:



5140
5141
5142
5143
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 5140

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

#update_source_server_replication_type(params = {}) ⇒ Types::SourceServer

Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.

Examples:

Request syntax with placeholder values


resp = client.update_source_server_replication_type({
  account_id: "AccountID",
  replication_type: "AGENT_BASED", # required, accepts AGENT_BASED, SNAPSHOT_SHIPPING
  source_server_id: "SourceServerID", # required
})

Response structure


resp.application_id #=> String
resp.arn #=> String
resp.connector_action.connector_arn #=> String
resp.connector_action.credentials_secret_arn #=> String
resp.data_replication_info.data_replication_error.error #=> String, one of "AGENT_NOT_SEEN", "SNAPSHOTS_FAILURE", "NOT_CONVERGING", "UNSTABLE_NETWORK", "FAILED_TO_CREATE_SECURITY_GROUP", "FAILED_TO_LAUNCH_REPLICATION_SERVER", "FAILED_TO_BOOT_REPLICATION_SERVER", "FAILED_TO_AUTHENTICATE_WITH_SERVICE", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", "FAILED_TO_CREATE_STAGING_DISKS", "FAILED_TO_ATTACH_STAGING_DISKS", "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", "FAILED_TO_START_DATA_TRANSFER", "UNSUPPORTED_VM_CONFIGURATION", "LAST_SNAPSHOT_JOB_FAILED"
resp.data_replication_info.data_replication_error.raw_error #=> String
resp.data_replication_info.data_replication_initiation.next_attempt_date_time #=> String
resp.data_replication_info.data_replication_initiation.start_date_time #=> String
resp.data_replication_info.data_replication_initiation.steps #=> Array
resp.data_replication_info.data_replication_initiation.steps[0].name #=> String, one of "WAIT", "CREATE_SECURITY_GROUP", "LAUNCH_REPLICATION_SERVER", "BOOT_REPLICATION_SERVER", "AUTHENTICATE_WITH_SERVICE", "DOWNLOAD_REPLICATION_SOFTWARE", "CREATE_STAGING_DISKS", "ATTACH_STAGING_DISKS", "PAIR_REPLICATION_SERVER_WITH_AGENT", "CONNECT_AGENT_TO_REPLICATION_SERVER", "START_DATA_TRANSFER"
resp.data_replication_info.data_replication_initiation.steps[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "SKIPPED"
resp.data_replication_info.data_replication_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED", "PENDING_SNAPSHOT_SHIPPING", "SHIPPING_SNAPSHOT"
resp.data_replication_info.eta_date_time #=> String
resp.data_replication_info.lag_duration #=> String
resp.data_replication_info.last_snapshot_date_time #=> String
resp.data_replication_info.replicated_disks #=> Array
resp.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].device_name #=> String
resp.data_replication_info.replicated_disks[0].replicated_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].rescanned_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].total_storage_bytes #=> Integer
resp.fqdn_for_action_framework #=> String
resp.is_archived #=> Boolean
resp.launched_instance.ec2_instance_id #=> String
resp.launched_instance.first_boot #=> String, one of "WAITING", "SUCCEEDED", "UNKNOWN", "STOPPED"
resp.launched_instance.job_id #=> String
resp.life_cycle.added_to_service_date_time #=> String
resp.life_cycle.elapsed_replication_duration #=> String
resp.life_cycle.first_byte_date_time #=> String
resp.life_cycle.last_cutover.finalized.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.job_id #=> String
resp.life_cycle.last_cutover.reverted.api_call_date_time #=> String
resp.life_cycle.last_seen_by_service_date_time #=> String
resp.life_cycle.last_test.finalized.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.job_id #=> String
resp.life_cycle.last_test.reverted.api_call_date_time #=> String
resp.life_cycle.state #=> String, one of "STOPPED", "NOT_READY", "READY_FOR_TEST", "TESTING", "READY_FOR_CUTOVER", "CUTTING_OVER", "CUTOVER", "DISCONNECTED", "DISCOVERED", "PENDING_INSTALLATION"
resp.replication_type #=> String, one of "AGENT_BASED", "SNAPSHOT_SHIPPING"
resp.source_properties.cpus #=> Array
resp.source_properties.cpus[0].cores #=> Integer
resp.source_properties.cpus[0].model_name #=> String
resp.source_properties.disks #=> Array
resp.source_properties.disks[0].bytes #=> Integer
resp.source_properties.disks[0].device_name #=> String
resp.source_properties.identification_hints.aws_instance_id #=> String
resp.source_properties.identification_hints.fqdn #=> String
resp.source_properties.identification_hints.hostname #=> String
resp.source_properties.identification_hints.vm_path #=> String
resp.source_properties.identification_hints.vm_ware_uuid #=> String
resp.source_properties.last_updated_date_time #=> String
resp.source_properties.network_interfaces #=> Array
resp.source_properties.network_interfaces[0].ips #=> Array
resp.source_properties.network_interfaces[0].ips[0] #=> String
resp.source_properties.network_interfaces[0].is_primary #=> Boolean
resp.source_properties.network_interfaces[0].mac_address #=> String
resp.source_properties.os.full_string #=> String
resp.source_properties.ram_bytes #=> Integer
resp.source_properties.recommended_instance_type #=> String
resp.source_server_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.user_provided_id #=> String
resp.vcenter_client_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Account ID on which to update replication type.

  • :replication_type (required, String) —

    Replication type to which to update source server.

  • :source_server_id (required, String) —

    ID of source server on which to update replication type.

Returns:

See Also:



5254
5255
5256
5257
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 5254

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

#update_wave(params = {}) ⇒ Types::Wave

Update wave.

Examples:

Request syntax with placeholder values


resp = client.update_wave({
  account_id: "AccountID",
  description: "WaveDescription",
  name: "WaveName",
  wave_id: "WaveID", # required
})

Response structure


resp.arn #=> String
resp.creation_date_time #=> String
resp.description #=> String
resp.is_archived #=> Boolean
resp.last_modified_date_time #=> String
resp.name #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.wave_aggregated_status.health_status #=> String, one of "HEALTHY", "LAGGING", "ERROR"
resp.wave_aggregated_status.last_update_date_time #=> String
resp.wave_aggregated_status.progress_status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED"
resp.wave_aggregated_status.replication_started_date_time #=> String
resp.wave_aggregated_status.total_applications #=> Integer
resp.wave_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    Account ID.

  • :description (String) —

    Wave description.

  • :name (String) —

    Wave name.

  • :wave_id (required, String) —

    Wave ID.

Returns:

See Also:



5315
5316
5317
5318
 
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 5315

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