Class: Aws::MigrationHubStrategyRecommendations::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-migrationhubstrategyrecommendations/client.rb

Overview

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

client = Aws::MigrationHubStrategyRecommendations::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ENV, ENV, ENV, and ENV

    • ‘~/.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 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:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :client_side_monitoring (Boolean) — default: false —

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

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

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000 —

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

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

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

  • :convert_params (Boolean) — default: true —

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

  • :correct_clock_skew (Boolean) — default: true —

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

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

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

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :disable_request_compression (Boolean) — default: false —

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

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

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

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

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

  • :endpoint_cache_max_threads (Integer) — default: 10 —

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

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

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

  • :ignore_configured_endpoint_urls (Boolean) —

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

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

    The log formatter.

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

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

  • :logger (Logger) —

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

  • :max_attempts (Integer) — default: 3 —

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

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

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

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

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

  • :retry_backoff (Proc) —

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

  • :retry_base_delay (Float) — default: 0.3 —

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

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

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

    @see 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:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

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

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

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

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

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

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

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

  • :use_dualstack_endpoint (Boolean) —

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

  • :use_fips_endpoint (Boolean) —

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

  • :validate_params (Boolean) — default: true —

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

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

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



444
445
446
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 444

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1652
1653
1654
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 1652

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



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

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 1625

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::MigrationHubStrategyRecommendations')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-migrationhubstrategyrecommendations'
  context[:gem_version] = '1.32.0'
  Seahorse::Client::Request.new(handlers, context)
end

#get_application_component_details(params = {}) ⇒ Types::GetApplicationComponentDetailsResponse

Retrieves details about an application component.

Examples:

Request syntax with placeholder values


resp = client.get_application_component_details({
  application_component_id: "ApplicationComponentId", # required
})

Response structure


resp.application_component_detail.analysis_status #=> String, one of "ANALYSIS_TO_BE_SCHEDULED", "ANALYSIS_STARTED", "ANALYSIS_SUCCESS", "ANALYSIS_FAILED", "ANALYSIS_PARTIAL_SUCCESS", "UNCONFIGURED", "CONFIGURED"
resp.application_component_detail.antipattern_report_s3_object.s3_bucket #=> String
resp.application_component_detail.antipattern_report_s3_object.s3key #=> String
resp.application_component_detail.antipattern_report_status #=> String, one of "FAILED", "IN_PROGRESS", "SUCCESS"
resp.application_component_detail.antipattern_report_status_message #=> String
resp.application_component_detail.app_type #=> String, one of "DotNetFramework", "Java", "SQLServer", "IIS", "Oracle", "Other", "Tomcat", "JBoss", "Spring", "Mongo DB", "DB2", "Maria DB", "MySQL", "Sybase", "PostgreSQLServer", "Cassandra", "IBM WebSphere", "Oracle WebLogic", "Visual Basic", "Unknown", "DotnetCore", "Dotnet"
resp.application_component_detail.app_unit_error.app_unit_error_category #=> String, one of "CREDENTIAL_ERROR", "CONNECTIVITY_ERROR", "PERMISSION_ERROR", "UNSUPPORTED_ERROR", "OTHER_ERROR"
resp.application_component_detail.associated_server_id #=> String
resp.application_component_detail.database_config_detail.secret_name #=> String
resp.application_component_detail.id #=> String
resp.application_component_detail.inclusion_status #=> String, one of "excludeFromAssessment", "includeInAssessment"
resp.application_component_detail.last_analyzed_timestamp #=> Time
resp.application_component_detail.list_antipattern_severity_summary #=> Array
resp.application_component_detail.list_antipattern_severity_summary[0].count #=> Integer
resp.application_component_detail.list_antipattern_severity_summary[0].severity #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.application_component_detail.more_server_association_exists #=> Boolean
resp.application_component_detail.name #=> String
resp.application_component_detail.os_driver #=> String
resp.application_component_detail.os_version #=> String
resp.application_component_detail.recommendation_set.strategy #=> String, one of "Rehost", "Retirement", "Refactor", "Replatform", "Retain", "Relocate", "Repurchase"
resp.application_component_detail.recommendation_set.target_destination #=> String, one of "None specified", "AWS Elastic BeanStalk", "AWS Fargate", "Amazon Elastic Cloud Compute (EC2)", "Amazon Elastic Container Service (ECS)", "Amazon Elastic Kubernetes Service (EKS)", "Aurora MySQL", "Aurora PostgreSQL", "Amazon Relational Database Service on MySQL", "Amazon Relational Database Service on PostgreSQL", "Amazon DocumentDB", "Amazon DynamoDB", "Amazon Relational Database Service", "Babelfish for Aurora PostgreSQL"
resp.application_component_detail.recommendation_set.transformation_tool.description #=> String
resp.application_component_detail.recommendation_set.transformation_tool.name #=> String, one of "App2Container", "Porting Assistant For .NET", "End of Support Migration", "Windows Web Application Migration Assistant", "Application Migration Service", "Strategy Recommendation Support", "In Place Operating System Upgrade", "Schema Conversion Tool", "Database Migration Service", "Native SQL Server Backup/Restore"
resp.application_component_detail.recommendation_set.transformation_tool.tranformation_tool_installation_link #=> String
resp.application_component_detail.resource_sub_type #=> String, one of "Database", "Process", "DatabaseProcess"
resp.application_component_detail.result_list #=> Array
resp.application_component_detail.result_list[0].analysis_status.runtime_analysis_status #=> String, one of "ANALYSIS_TO_BE_SCHEDULED", "ANALYSIS_STARTED", "ANALYSIS_SUCCESS", "ANALYSIS_FAILED"
resp.application_component_detail.result_list[0].analysis_status.src_code_or_db_analysis_status #=> String, one of "ANALYSIS_TO_BE_SCHEDULED", "ANALYSIS_STARTED", "ANALYSIS_SUCCESS", "ANALYSIS_FAILED", "ANALYSIS_PARTIAL_SUCCESS", "UNCONFIGURED", "CONFIGURED"
resp.application_component_detail.result_list[0].analysis_type #=> String, one of "SOURCE_CODE_ANALYSIS", "DATABASE_ANALYSIS", "RUNTIME_ANALYSIS", "BINARY_ANALYSIS"
resp.application_component_detail.result_list[0].antipattern_report_result_list #=> Array
resp.application_component_detail.result_list[0].antipattern_report_result_list[0].analyzer_name.binary_analyzer_name #=> String, one of "DLL_ANALYZER", "BYTECODE_ANALYZER"
resp.application_component_detail.result_list[0].antipattern_report_result_list[0].analyzer_name.run_time_analyzer_name #=> String, one of "A2C_ANALYZER", "REHOST_ANALYZER", "EMP_PA_ANALYZER", "DATABASE_ANALYZER", "SCT_ANALYZER"
resp.application_component_detail.result_list[0].antipattern_report_result_list[0].analyzer_name.source_code_analyzer_name #=> String, one of "CSHARP_ANALYZER", "JAVA_ANALYZER", "BYTECODE_ANALYZER", "PORTING_ASSISTANT"
resp.application_component_detail.result_list[0].antipattern_report_result_list[0].anti_pattern_report_s3_object.s3_bucket #=> String
resp.application_component_detail.result_list[0].antipattern_report_result_list[0].anti_pattern_report_s3_object.s3key #=> String
resp.application_component_detail.result_list[0].antipattern_report_result_list[0].antipattern_report_status #=> String, one of "FAILED", "IN_PROGRESS", "SUCCESS"
resp.application_component_detail.result_list[0].antipattern_report_result_list[0].antipattern_report_status_message #=> String
resp.application_component_detail.result_list[0].status_message #=> String
resp.application_component_detail.runtime_status #=> String, one of "ANALYSIS_TO_BE_SCHEDULED", "ANALYSIS_STARTED", "ANALYSIS_SUCCESS", "ANALYSIS_FAILED"
resp.application_component_detail.runtime_status_message #=> String
resp.application_component_detail.source_code_repositories #=> Array
resp.application_component_detail.source_code_repositories[0].branch #=> String
resp.application_component_detail.source_code_repositories[0].project_name #=> String
resp.application_component_detail.source_code_repositories[0].repository #=> String
resp.application_component_detail.source_code_repositories[0].version_control_type #=> String
resp.application_component_detail.status_message #=> String
resp.associated_applications #=> Array
resp.associated_applications[0].id #=> String
resp.associated_applications[0].name #=> String
resp.associated_server_ids #=> Array
resp.associated_server_ids[0] #=> String
resp.more_application_resource #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :application_component_id (required, String) —

    The ID of the application component. The ID is unique within an AWS account.

Returns:

See Also:



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

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

#get_application_component_strategies(params = {}) ⇒ Types::GetApplicationComponentStrategiesResponse

Retrieves a list of all the recommended strategies and tools for an application component running on a server.

Examples:

Request syntax with placeholder values


resp = client.get_application_component_strategies({
  application_component_id: "ApplicationComponentId", # required
})

Response structure


resp.application_component_strategies #=> Array
resp.application_component_strategies[0].is_preferred #=> Boolean
resp.application_component_strategies[0].recommendation.strategy #=> String, one of "Rehost", "Retirement", "Refactor", "Replatform", "Retain", "Relocate", "Repurchase"
resp.application_component_strategies[0].recommendation.target_destination #=> String, one of "None specified", "AWS Elastic BeanStalk", "AWS Fargate", "Amazon Elastic Cloud Compute (EC2)", "Amazon Elastic Container Service (ECS)", "Amazon Elastic Kubernetes Service (EKS)", "Aurora MySQL", "Aurora PostgreSQL", "Amazon Relational Database Service on MySQL", "Amazon Relational Database Service on PostgreSQL", "Amazon DocumentDB", "Amazon DynamoDB", "Amazon Relational Database Service", "Babelfish for Aurora PostgreSQL"
resp.application_component_strategies[0].recommendation.transformation_tool.description #=> String
resp.application_component_strategies[0].recommendation.transformation_tool.name #=> String, one of "App2Container", "Porting Assistant For .NET", "End of Support Migration", "Windows Web Application Migration Assistant", "Application Migration Service", "Strategy Recommendation Support", "In Place Operating System Upgrade", "Schema Conversion Tool", "Database Migration Service", "Native SQL Server Backup/Restore"
resp.application_component_strategies[0].recommendation.transformation_tool.tranformation_tool_installation_link #=> String
resp.application_component_strategies[0].status #=> String, one of "recommended", "viableOption", "notRecommended", "potential"

Parameters:

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

    ({})

Options Hash (params):

  • :application_component_id (required, String) —

    The ID of the application component. The ID is unique within an AWS account.

Returns:

See Also:



565
566
567
568
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 565

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

#get_assessment(params = {}) ⇒ Types::GetAssessmentResponse

Retrieves the status of an on-going assessment.

Examples:

Request syntax with placeholder values


resp = client.get_assessment({
  id: "AsyncTaskId", # required
})

Response structure


resp.assessment_targets #=> Array
resp.assessment_targets[0].condition #=> String, one of "EQUALS", "NOT_EQUALS", "CONTAINS", "NOT_CONTAINS"
resp.assessment_targets[0].name #=> String
resp.assessment_targets[0].values #=> Array
resp.assessment_targets[0].values[0] #=> String
resp.data_collection_details.completion_time #=> Time
resp.data_collection_details.failed #=> Integer
resp.data_collection_details.in_progress #=> Integer
resp.data_collection_details.servers #=> Integer
resp.data_collection_details.start_time #=> Time
resp.data_collection_details.status #=> String, one of "IN_PROGRESS", "COMPLETE", "FAILED", "STOPPED"
resp.data_collection_details.status_message #=> String
resp.data_collection_details.success #=> Integer
resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ‘assessmentid` returned by StartAssessment.

Returns:

See Also:



608
609
610
611
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 608

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

#get_import_file_task(params = {}) ⇒ Types::GetImportFileTaskResponse

Retrieves the details about a specific import task.

Examples:

Request syntax with placeholder values


resp = client.get_import_file_task({
  id: "String", # required
})

Response structure


resp.completion_time #=> Time
resp.id #=> String
resp.import_name #=> String
resp.input_s3_bucket #=> String
resp.input_s3_key #=> String
resp.number_of_records_failed #=> Integer
resp.number_of_records_success #=> Integer
resp.start_time #=> Time
resp.status #=> String, one of "ImportInProgress", "ImportFailed", "ImportPartialSuccess", "ImportSuccess", "DeleteInProgress", "DeleteFailed", "DeletePartialSuccess", "DeleteSuccess"
resp.status_report_s3_bucket #=> String
resp.status_report_s3_key #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the import file task. This ID is returned in the response of StartImportFileTask.

Returns:

See Also:



657
658
659
660
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 657

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

#get_latest_assessment_id(params = {}) ⇒ Types::GetLatestAssessmentIdResponse

Retrieve the latest ID of a specific assessment task.

Examples:

Response structure


resp.id #=> String

Parameters:

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

    ({})

Returns:

See Also:



676
677
678
679
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 676

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

#get_portfolio_preferences(params = {}) ⇒ Types::GetPortfolioPreferencesResponse

Retrieves your migration and modernization preferences.

Examples:

Response structure


resp.application_mode #=> String, one of "ALL", "KNOWN", "UNKNOWN"
resp.application_preferences.management_preference.aws_managed_resources.target_destination #=> Array
resp.application_preferences.management_preference.aws_managed_resources.target_destination[0] #=> String, one of "None specified", "AWS Elastic BeanStalk", "AWS Fargate"
resp.application_preferences.management_preference.no_preference.target_destination #=> Array
resp.application_preferences.management_preference.no_preference.target_destination[0] #=> String, one of "None specified", "AWS Elastic BeanStalk", "AWS Fargate", "Amazon Elastic Cloud Compute (EC2)", "Amazon Elastic Container Service (ECS)", "Amazon Elastic Kubernetes Service (EKS)"
resp.application_preferences.management_preference.self_manage_resources.target_destination #=> Array
resp.application_preferences.management_preference.self_manage_resources.target_destination[0] #=> String, one of "None specified", "Amazon Elastic Cloud Compute (EC2)", "Amazon Elastic Container Service (ECS)", "Amazon Elastic Kubernetes Service (EKS)"
resp.database_preferences.database_management_preference #=> String, one of "AWS-managed", "Self-manage", "No preference"
resp.database_preferences.database_migration_preference.heterogeneous.target_database_engine #=> Array
resp.database_preferences.database_migration_preference.heterogeneous.target_database_engine[0] #=> String, one of "None specified", "Amazon Aurora", "AWS PostgreSQL", "MySQL", "Microsoft SQL Server", "Oracle Database", "MariaDB", "SAP", "Db2 LUW", "MongoDB"
resp.database_preferences.database_migration_preference.homogeneous.target_database_engine #=> Array
resp.database_preferences.database_migration_preference.homogeneous.target_database_engine[0] #=> String, one of "None specified"
resp.database_preferences.database_migration_preference.no_preference.target_database_engine #=> Array
resp.database_preferences.database_migration_preference.no_preference.target_database_engine[0] #=> String, one of "None specified", "Amazon Aurora", "AWS PostgreSQL", "MySQL", "Microsoft SQL Server", "Oracle Database", "MariaDB", "SAP", "Db2 LUW", "MongoDB"
resp.prioritize_business_goals.business_goals.license_cost_reduction #=> Integer
resp.prioritize_business_goals.business_goals.modernize_infrastructure_with_cloud_native_technologies #=> Integer
resp.prioritize_business_goals.business_goals.reduce_operational_overhead_with_managed_services #=> Integer
resp.prioritize_business_goals.business_goals.speed_of_migration #=> Integer

Parameters:

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

    ({})

Returns:

See Also:



715
716
717
718
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 715

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

#get_portfolio_summary(params = {}) ⇒ Types::GetPortfolioSummaryResponse

Retrieves overall summary including the number of servers to rehost and the overall number of anti-patterns.

Examples:

Response structure


resp.assessment_summary.antipattern_report_s3_object.s3_bucket #=> String
resp.assessment_summary.antipattern_report_s3_object.s3key #=> String
resp.assessment_summary.antipattern_report_status #=> String, one of "FAILED", "IN_PROGRESS", "SUCCESS"
resp.assessment_summary.antipattern_report_status_message #=> String
resp.assessment_summary.last_analyzed_timestamp #=> Time
resp.assessment_summary.list_antipattern_severity_summary #=> Array
resp.assessment_summary.list_antipattern_severity_summary[0].count #=> Integer
resp.assessment_summary.list_antipattern_severity_summary[0].severity #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.assessment_summary.list_application_component_status_summary #=> Array
resp.assessment_summary.list_application_component_status_summary[0].count #=> Integer
resp.assessment_summary.list_application_component_status_summary[0].src_code_or_db_analysis_status #=> String, one of "ANALYSIS_TO_BE_SCHEDULED", "ANALYSIS_STARTED", "ANALYSIS_SUCCESS", "ANALYSIS_FAILED", "ANALYSIS_PARTIAL_SUCCESS", "UNCONFIGURED", "CONFIGURED"
resp.assessment_summary.list_application_component_strategy_summary #=> Array
resp.assessment_summary.list_application_component_strategy_summary[0].count #=> Integer
resp.assessment_summary.list_application_component_strategy_summary[0].strategy #=> String, one of "Rehost", "Retirement", "Refactor", "Replatform", "Retain", "Relocate", "Repurchase"
resp.assessment_summary.list_application_component_summary #=> Array
resp.assessment_summary.list_application_component_summary[0].app_type #=> String, one of "DotNetFramework", "Java", "SQLServer", "IIS", "Oracle", "Other", "Tomcat", "JBoss", "Spring", "Mongo DB", "DB2", "Maria DB", "MySQL", "Sybase", "PostgreSQLServer", "Cassandra", "IBM WebSphere", "Oracle WebLogic", "Visual Basic", "Unknown", "DotnetCore", "Dotnet"
resp.assessment_summary.list_application_component_summary[0].count #=> Integer
resp.assessment_summary.list_server_status_summary #=> Array
resp.assessment_summary.list_server_status_summary[0].count #=> Integer
resp.assessment_summary.list_server_status_summary[0].run_time_assessment_status #=> String, one of "dataCollectionTaskToBeScheduled", "dataCollectionTaskScheduled", "dataCollectionTaskStarted", "dataCollectionTaskStopped", "dataCollectionTaskSuccess", "dataCollectionTaskFailed", "dataCollectionTaskPartialSuccess"
resp.assessment_summary.list_server_strategy_summary #=> Array
resp.assessment_summary.list_server_strategy_summary[0].count #=> Integer
resp.assessment_summary.list_server_strategy_summary[0].strategy #=> String, one of "Rehost", "Retirement", "Refactor", "Replatform", "Retain", "Relocate", "Repurchase"
resp.assessment_summary.list_server_summary #=> Array
resp.assessment_summary.list_server_summary[0].server_os_type #=> String, one of "WindowsServer", "AmazonLinux", "EndOfSupportWindowsServer", "Redhat", "Other"
resp.assessment_summary.list_server_summary[0].count #=> Integer

Parameters:

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

    ({})

Returns:

See Also:



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

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

#get_recommendation_report_details(params = {}) ⇒ Types::GetRecommendationReportDetailsResponse

Retrieves detailed information about the specified recommendation report.

Examples:

Request syntax with placeholder values


resp = client.get_recommendation_report_details({
  id: "RecommendationTaskId", # required
})

Response structure


resp.id #=> String
resp.recommendation_report_details.completion_time #=> Time
resp.recommendation_report_details.s3_bucket #=> String
resp.recommendation_report_details.s3_keys #=> Array
resp.recommendation_report_details.s3_keys[0] #=> String
resp.recommendation_report_details.start_time #=> Time
resp.recommendation_report_details.status #=> String, one of "FAILED", "IN_PROGRESS", "SUCCESS"
resp.recommendation_report_details.status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The recommendation report generation task ‘id` returned by StartRecommendationReportGeneration.

Returns:

See Also:



798
799
800
801
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 798

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

#get_server_details(params = {}) ⇒ Types::GetServerDetailsResponse

Retrieves detailed information about a specified server.

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

Examples:

Request syntax with placeholder values


resp = client.get_server_details({
  max_results: 1,
  next_token: "NextToken",
  server_id: "ServerId", # required
})

Response structure


resp.associated_applications #=> Array
resp.associated_applications[0].id #=> String
resp.associated_applications[0].name #=> String
resp.next_token #=> String
resp.server_detail.antipattern_report_s3_object.s3_bucket #=> String
resp.server_detail.antipattern_report_s3_object.s3key #=> String
resp.server_detail.antipattern_report_status #=> String, one of "FAILED", "IN_PROGRESS", "SUCCESS"
resp.server_detail.antipattern_report_status_message #=> String
resp.server_detail.application_component_strategy_summary #=> Array
resp.server_detail.application_component_strategy_summary[0].count #=> Integer
resp.server_detail.application_component_strategy_summary[0].strategy #=> String, one of "Rehost", "Retirement", "Refactor", "Replatform", "Retain", "Relocate", "Repurchase"
resp.server_detail.data_collection_status #=> String, one of "dataCollectionTaskToBeScheduled", "dataCollectionTaskScheduled", "dataCollectionTaskStarted", "dataCollectionTaskStopped", "dataCollectionTaskSuccess", "dataCollectionTaskFailed", "dataCollectionTaskPartialSuccess"
resp.server_detail.id #=> String
resp.server_detail.last_analyzed_timestamp #=> Time
resp.server_detail.list_antipattern_severity_summary #=> Array
resp.server_detail.list_antipattern_severity_summary[0].count #=> Integer
resp.server_detail.list_antipattern_severity_summary[0].severity #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.server_detail.name #=> String
resp.server_detail.recommendation_set.strategy #=> String, one of "Rehost", "Retirement", "Refactor", "Replatform", "Retain", "Relocate", "Repurchase"
resp.server_detail.recommendation_set.target_destination #=> String, one of "None specified", "AWS Elastic BeanStalk", "AWS Fargate", "Amazon Elastic Cloud Compute (EC2)", "Amazon Elastic Container Service (ECS)", "Amazon Elastic Kubernetes Service (EKS)", "Aurora MySQL", "Aurora PostgreSQL", "Amazon Relational Database Service on MySQL", "Amazon Relational Database Service on PostgreSQL", "Amazon DocumentDB", "Amazon DynamoDB", "Amazon Relational Database Service", "Babelfish for Aurora PostgreSQL"
resp.server_detail.recommendation_set.transformation_tool.description #=> String
resp.server_detail.recommendation_set.transformation_tool.name #=> String, one of "App2Container", "Porting Assistant For .NET", "End of Support Migration", "Windows Web Application Migration Assistant", "Application Migration Service", "Strategy Recommendation Support", "In Place Operating System Upgrade", "Schema Conversion Tool", "Database Migration Service", "Native SQL Server Backup/Restore"
resp.server_detail.recommendation_set.transformation_tool.tranformation_tool_installation_link #=> String
resp.server_detail.server_error.server_error_category #=> String, one of "CONNECTIVITY_ERROR", "CREDENTIAL_ERROR", "PERMISSION_ERROR", "ARCHITECTURE_ERROR", "OTHER_ERROR"
resp.server_detail.server_type #=> String
resp.server_detail.status_message #=> String
resp.server_detail.system_info.cpu_architecture #=> String
resp.server_detail.system_info.file_system_type #=> String
resp.server_detail.system_info.network_info_list #=> Array
resp.server_detail.system_info.network_info_list[0].interface_name #=> String
resp.server_detail.system_info.network_info_list[0].ip_address #=> String
resp.server_detail.system_info.network_info_list[0].mac_address #=> String
resp.server_detail.system_info.network_info_list[0].net_mask #=> String
resp.server_detail.system_info.os_info.type #=> String, one of "LINUX", "WINDOWS"
resp.server_detail.system_info.os_info.version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to include in the response. The maximum value is 100.

  • :next_token (String) —

    The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set ‘maxResults` to 10. You’ll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

  • :server_id (required, String) —

    The ID of the server.

Returns:

See Also:



877
878
879
880
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 877

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

#get_server_strategies(params = {}) ⇒ Types::GetServerStrategiesResponse

Retrieves recommended strategies and tools for the specified server.

Examples:

Request syntax with placeholder values


resp = client.get_server_strategies({
  server_id: "ServerId", # required
})

Response structure


resp.server_strategies #=> Array
resp.server_strategies[0].is_preferred #=> Boolean
resp.server_strategies[0].number_of_application_components #=> Integer
resp.server_strategies[0].recommendation.strategy #=> String, one of "Rehost", "Retirement", "Refactor", "Replatform", "Retain", "Relocate", "Repurchase"
resp.server_strategies[0].recommendation.target_destination #=> String, one of "None specified", "AWS Elastic BeanStalk", "AWS Fargate", "Amazon Elastic Cloud Compute (EC2)", "Amazon Elastic Container Service (ECS)", "Amazon Elastic Kubernetes Service (EKS)", "Aurora MySQL", "Aurora PostgreSQL", "Amazon Relational Database Service on MySQL", "Amazon Relational Database Service on PostgreSQL", "Amazon DocumentDB", "Amazon DynamoDB", "Amazon Relational Database Service", "Babelfish for Aurora PostgreSQL"
resp.server_strategies[0].recommendation.transformation_tool.description #=> String
resp.server_strategies[0].recommendation.transformation_tool.name #=> String, one of "App2Container", "Porting Assistant For .NET", "End of Support Migration", "Windows Web Application Migration Assistant", "Application Migration Service", "Strategy Recommendation Support", "In Place Operating System Upgrade", "Schema Conversion Tool", "Database Migration Service", "Native SQL Server Backup/Restore"
resp.server_strategies[0].recommendation.transformation_tool.tranformation_tool_installation_link #=> String
resp.server_strategies[0].status #=> String, one of "recommended", "viableOption", "notRecommended", "potential"

Parameters:

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

    ({})

Options Hash (params):

  • :server_id (required, String) —

    The ID of the server.

Returns:

See Also:



913
914
915
916
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 913

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

#list_analyzable_servers(params = {}) ⇒ Types::ListAnalyzableServersResponse

Retrieves a list of all the servers fetched from customer vCenter using Strategy Recommendation Collector.

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_analyzable_servers({
  max_results: 1,
  next_token: "NextToken",
  sort: "ASC", # accepts ASC, DESC
})

Response structure


resp.analyzable_servers #=> Array
resp.analyzable_servers[0].hostname #=> String
resp.analyzable_servers[0].ip_address #=> String
resp.analyzable_servers[0].source #=> String
resp.analyzable_servers[0].vm_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to include in the response. The maximum value is 100.

  • :next_token (String) —

    The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You’ll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

  • :sort (String) —

    Specifies whether to sort by ascending (ASC) or descending (DESC) order.

Returns:

See Also:



964
965
966
967
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 964

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

#list_application_components(params = {}) ⇒ Types::ListApplicationComponentsResponse

Retrieves a list of all the application components (processes).

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

Examples:

Request syntax with placeholder values


resp = client.list_application_components({
  application_component_criteria: "NOT_DEFINED", # accepts NOT_DEFINED, APP_NAME, SERVER_ID, APP_TYPE, STRATEGY, DESTINATION, ANALYSIS_STATUS, ERROR_CATEGORY
  filter_value: "ListApplicationComponentsRequestFilterValueString",
  group_id_filter: [
    {
      name: "ExternalId", # accepts ExternalId, ExternalSourceType
      value: "String",
    },
  ],
  max_results: 1,
  next_token: "NextToken",
  sort: "ASC", # accepts ASC, DESC
})

Response structure


resp.application_component_infos #=> Array
resp.application_component_infos[0].analysis_status #=> String, one of "ANALYSIS_TO_BE_SCHEDULED", "ANALYSIS_STARTED", "ANALYSIS_SUCCESS", "ANALYSIS_FAILED", "ANALYSIS_PARTIAL_SUCCESS", "UNCONFIGURED", "CONFIGURED"
resp.application_component_infos[0].antipattern_report_s3_object.s3_bucket #=> String
resp.application_component_infos[0].antipattern_report_s3_object.s3key #=> String
resp.application_component_infos[0].antipattern_report_status #=> String, one of "FAILED", "IN_PROGRESS", "SUCCESS"
resp.application_component_infos[0].antipattern_report_status_message #=> String
resp.application_component_infos[0].app_type #=> String, one of "DotNetFramework", "Java", "SQLServer", "IIS", "Oracle", "Other", "Tomcat", "JBoss", "Spring", "Mongo DB", "DB2", "Maria DB", "MySQL", "Sybase", "PostgreSQLServer", "Cassandra", "IBM WebSphere", "Oracle WebLogic", "Visual Basic", "Unknown", "DotnetCore", "Dotnet"
resp.application_component_infos[0].app_unit_error.app_unit_error_category #=> String, one of "CREDENTIAL_ERROR", "CONNECTIVITY_ERROR", "PERMISSION_ERROR", "UNSUPPORTED_ERROR", "OTHER_ERROR"
resp.application_component_infos[0].associated_server_id #=> String
resp.application_component_infos[0].database_config_detail.secret_name #=> String
resp.application_component_infos[0].id #=> String
resp.application_component_infos[0].inclusion_status #=> String, one of "excludeFromAssessment", "includeInAssessment"
resp.application_component_infos[0].last_analyzed_timestamp #=> Time
resp.application_component_infos[0].list_antipattern_severity_summary #=> Array
resp.application_component_infos[0].list_antipattern_severity_summary[0].count #=> Integer
resp.application_component_infos[0].list_antipattern_severity_summary[0].severity #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.application_component_infos[0].more_server_association_exists #=> Boolean
resp.application_component_infos[0].name #=> String
resp.application_component_infos[0].os_driver #=> String
resp.application_component_infos[0].os_version #=> String
resp.application_component_infos[0].recommendation_set.strategy #=> String, one of "Rehost", "Retirement", "Refactor", "Replatform", "Retain", "Relocate", "Repurchase"
resp.application_component_infos[0].recommendation_set.target_destination #=> String, one of "None specified", "AWS Elastic BeanStalk", "AWS Fargate", "Amazon Elastic Cloud Compute (EC2)", "Amazon Elastic Container Service (ECS)", "Amazon Elastic Kubernetes Service (EKS)", "Aurora MySQL", "Aurora PostgreSQL", "Amazon Relational Database Service on MySQL", "Amazon Relational Database Service on PostgreSQL", "Amazon DocumentDB", "Amazon DynamoDB", "Amazon Relational Database Service", "Babelfish for Aurora PostgreSQL"
resp.application_component_infos[0].recommendation_set.transformation_tool.description #=> String
resp.application_component_infos[0].recommendation_set.transformation_tool.name #=> String, one of "App2Container", "Porting Assistant For .NET", "End of Support Migration", "Windows Web Application Migration Assistant", "Application Migration Service", "Strategy Recommendation Support", "In Place Operating System Upgrade", "Schema Conversion Tool", "Database Migration Service", "Native SQL Server Backup/Restore"
resp.application_component_infos[0].recommendation_set.transformation_tool.tranformation_tool_installation_link #=> String
resp.application_component_infos[0].resource_sub_type #=> String, one of "Database", "Process", "DatabaseProcess"
resp.application_component_infos[0].result_list #=> Array
resp.application_component_infos[0].result_list[0].analysis_status.runtime_analysis_status #=> String, one of "ANALYSIS_TO_BE_SCHEDULED", "ANALYSIS_STARTED", "ANALYSIS_SUCCESS", "ANALYSIS_FAILED"
resp.application_component_infos[0].result_list[0].analysis_status.src_code_or_db_analysis_status #=> String, one of "ANALYSIS_TO_BE_SCHEDULED", "ANALYSIS_STARTED", "ANALYSIS_SUCCESS", "ANALYSIS_FAILED", "ANALYSIS_PARTIAL_SUCCESS", "UNCONFIGURED", "CONFIGURED"
resp.application_component_infos[0].result_list[0].analysis_type #=> String, one of "SOURCE_CODE_ANALYSIS", "DATABASE_ANALYSIS", "RUNTIME_ANALYSIS", "BINARY_ANALYSIS"
resp.application_component_infos[0].result_list[0].antipattern_report_result_list #=> Array
resp.application_component_infos[0].result_list[0].antipattern_report_result_list[0].analyzer_name.binary_analyzer_name #=> String, one of "DLL_ANALYZER", "BYTECODE_ANALYZER"
resp.application_component_infos[0].result_list[0].antipattern_report_result_list[0].analyzer_name.run_time_analyzer_name #=> String, one of "A2C_ANALYZER", "REHOST_ANALYZER", "EMP_PA_ANALYZER", "DATABASE_ANALYZER", "SCT_ANALYZER"
resp.application_component_infos[0].result_list[0].antipattern_report_result_list[0].analyzer_name.source_code_analyzer_name #=> String, one of "CSHARP_ANALYZER", "JAVA_ANALYZER", "BYTECODE_ANALYZER", "PORTING_ASSISTANT"
resp.application_component_infos[0].result_list[0].antipattern_report_result_list[0].anti_pattern_report_s3_object.s3_bucket #=> String
resp.application_component_infos[0].result_list[0].antipattern_report_result_list[0].anti_pattern_report_s3_object.s3key #=> String
resp.application_component_infos[0].result_list[0].antipattern_report_result_list[0].antipattern_report_status #=> String, one of "FAILED", "IN_PROGRESS", "SUCCESS"
resp.application_component_infos[0].result_list[0].antipattern_report_result_list[0].antipattern_report_status_message #=> String
resp.application_component_infos[0].result_list[0].status_message #=> String
resp.application_component_infos[0].runtime_status #=> String, one of "ANALYSIS_TO_BE_SCHEDULED", "ANALYSIS_STARTED", "ANALYSIS_SUCCESS", "ANALYSIS_FAILED"
resp.application_component_infos[0].runtime_status_message #=> String
resp.application_component_infos[0].source_code_repositories #=> Array
resp.application_component_infos[0].source_code_repositories[0].branch #=> String
resp.application_component_infos[0].source_code_repositories[0].project_name #=> String
resp.application_component_infos[0].source_code_repositories[0].repository #=> String
resp.application_component_infos[0].source_code_repositories[0].version_control_type #=> String
resp.application_component_infos[0].status_message #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_component_criteria (String) —

    Criteria for filtering the list of application components.

  • :filter_value (String) —

    Specify the value based on the application component criteria type. For example, if ‘applicationComponentCriteria` is set to `SERVER_ID` and `filterValue` is set to `server1`, then ListApplicationComponents returns all the application components running on server1.

  • :group_id_filter (Array<Types::Group>) —

    The group ID specified in to filter on.

  • :max_results (Integer) —

    The maximum number of items to include in the response. The maximum value is 100.

  • :next_token (String) —

    The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set ‘maxResults` to 10. You’ll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

  • :sort (String) —

    Specifies whether to sort by ascending (‘ASC`) or descending (`DESC`) order.

Returns:

See Also:



1076
1077
1078
1079
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 1076

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

#list_collectors(params = {}) ⇒ Types::ListCollectorsResponse

Retrieves a list of all the installed collectors.

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

Response structure


resp.collectors #=> Array
resp.collectors[0].collector_health #=> String, one of "COLLECTOR_HEALTHY", "COLLECTOR_UNHEALTHY"
resp.collectors[0].collector_id #=> String
resp.collectors[0].collector_version #=> String
resp.collectors[0].configuration_summary.ip_address_based_remote_info_list #=> Array
resp.collectors[0].configuration_summary.ip_address_based_remote_info_list[0].auth_type #=> String, one of "NTLM", "SSH", "CERT"
resp.collectors[0].configuration_summary.ip_address_based_remote_info_list[0].ip_address_configuration_time_stamp #=> String
resp.collectors[0].configuration_summary.ip_address_based_remote_info_list[0].os_type #=> String, one of "LINUX", "WINDOWS"
resp.collectors[0].configuration_summary.pipeline_info_list #=> Array
resp.collectors[0].configuration_summary.pipeline_info_list[0].pipeline_configuration_time_stamp #=> String
resp.collectors[0].configuration_summary.pipeline_info_list[0].pipeline_type #=> String, one of "AZURE_DEVOPS"
resp.collectors[0].configuration_summary.remote_source_code_analysis_server_info.remote_source_code_analysis_server_configuration_timestamp #=> String
resp.collectors[0].configuration_summary.vcenter_based_remote_info_list #=> Array
resp.collectors[0].configuration_summary.vcenter_based_remote_info_list[0].os_type #=> String, one of "LINUX", "WINDOWS"
resp.collectors[0].configuration_summary.vcenter_based_remote_info_list[0].vcenter_configuration_time_stamp #=> String
resp.collectors[0].configuration_summary.version_control_info_list #=> Array
resp.collectors[0].configuration_summary.version_control_info_list[0].version_control_configuration_time_stamp #=> String
resp.collectors[0].configuration_summary.version_control_info_list[0].version_control_type #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "AZURE_DEVOPS_GIT"
resp.collectors[0].host_name #=> String
resp.collectors[0].ip_address #=> String
resp.collectors[0].last_activity_time_stamp #=> String
resp.collectors[0].registered_time_stamp #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to include in the response. The maximum value is 100.

  • :next_token (String) —

    The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set ‘maxResults` to 10. You’ll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

Returns:

See Also:



1138
1139
1140
1141
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 1138

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

#list_import_file_task(params = {}) ⇒ Types::ListImportFileTaskResponse

Retrieves a list of all the imports performed.

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

Response structure


resp.next_token #=> String
resp.task_infos #=> Array
resp.task_infos[0].completion_time #=> Time
resp.task_infos[0].id #=> String
resp.task_infos[0].import_name #=> String
resp.task_infos[0].input_s3_bucket #=> String
resp.task_infos[0].input_s3_key #=> String
resp.task_infos[0].number_of_records_failed #=> Integer
resp.task_infos[0].number_of_records_success #=> Integer
resp.task_infos[0].start_time #=> Time
resp.task_infos[0].status #=> String, one of "ImportInProgress", "ImportFailed", "ImportPartialSuccess", "ImportSuccess", "DeleteInProgress", "DeleteFailed", "DeletePartialSuccess", "DeleteSuccess"
resp.task_infos[0].status_report_s3_bucket #=> String
resp.task_infos[0].status_report_s3_key #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The total number of items to return. The maximum value is 100.

  • :next_token (String) —

    The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set ‘maxResults` to 10. You’ll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

Returns:

See Also:



1189
1190
1191
1192
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 1189

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

#list_servers(params = {}) ⇒ Types::ListServersResponse

Returns a list of all the servers.

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_servers({
  filter_value: "String",
  group_id_filter: [
    {
      name: "ExternalId", # accepts ExternalId, ExternalSourceType
      value: "String",
    },
  ],
  max_results: 1,
  next_token: "NextToken",
  server_criteria: "NOT_DEFINED", # accepts NOT_DEFINED, OS_NAME, STRATEGY, DESTINATION, SERVER_ID, ANALYSIS_STATUS, ERROR_CATEGORY
  sort: "ASC", # accepts ASC, DESC
})

Response structure


resp.next_token #=> String
resp.server_infos #=> Array
resp.server_infos[0].antipattern_report_s3_object.s3_bucket #=> String
resp.server_infos[0].antipattern_report_s3_object.s3key #=> String
resp.server_infos[0].antipattern_report_status #=> String, one of "FAILED", "IN_PROGRESS", "SUCCESS"
resp.server_infos[0].antipattern_report_status_message #=> String
resp.server_infos[0].application_component_strategy_summary #=> Array
resp.server_infos[0].application_component_strategy_summary[0].count #=> Integer
resp.server_infos[0].application_component_strategy_summary[0].strategy #=> String, one of "Rehost", "Retirement", "Refactor", "Replatform", "Retain", "Relocate", "Repurchase"
resp.server_infos[0].data_collection_status #=> String, one of "dataCollectionTaskToBeScheduled", "dataCollectionTaskScheduled", "dataCollectionTaskStarted", "dataCollectionTaskStopped", "dataCollectionTaskSuccess", "dataCollectionTaskFailed", "dataCollectionTaskPartialSuccess"
resp.server_infos[0].id #=> String
resp.server_infos[0].last_analyzed_timestamp #=> Time
resp.server_infos[0].list_antipattern_severity_summary #=> Array
resp.server_infos[0].list_antipattern_severity_summary[0].count #=> Integer
resp.server_infos[0].list_antipattern_severity_summary[0].severity #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.server_infos[0].name #=> String
resp.server_infos[0].recommendation_set.strategy #=> String, one of "Rehost", "Retirement", "Refactor", "Replatform", "Retain", "Relocate", "Repurchase"
resp.server_infos[0].recommendation_set.target_destination #=> String, one of "None specified", "AWS Elastic BeanStalk", "AWS Fargate", "Amazon Elastic Cloud Compute (EC2)", "Amazon Elastic Container Service (ECS)", "Amazon Elastic Kubernetes Service (EKS)", "Aurora MySQL", "Aurora PostgreSQL", "Amazon Relational Database Service on MySQL", "Amazon Relational Database Service on PostgreSQL", "Amazon DocumentDB", "Amazon DynamoDB", "Amazon Relational Database Service", "Babelfish for Aurora PostgreSQL"
resp.server_infos[0].recommendation_set.transformation_tool.description #=> String
resp.server_infos[0].recommendation_set.transformation_tool.name #=> String, one of "App2Container", "Porting Assistant For .NET", "End of Support Migration", "Windows Web Application Migration Assistant", "Application Migration Service", "Strategy Recommendation Support", "In Place Operating System Upgrade", "Schema Conversion Tool", "Database Migration Service", "Native SQL Server Backup/Restore"
resp.server_infos[0].recommendation_set.transformation_tool.tranformation_tool_installation_link #=> String
resp.server_infos[0].server_error.server_error_category #=> String, one of "CONNECTIVITY_ERROR", "CREDENTIAL_ERROR", "PERMISSION_ERROR", "ARCHITECTURE_ERROR", "OTHER_ERROR"
resp.server_infos[0].server_type #=> String
resp.server_infos[0].status_message #=> String
resp.server_infos[0].system_info.cpu_architecture #=> String
resp.server_infos[0].system_info.file_system_type #=> String
resp.server_infos[0].system_info.network_info_list #=> Array
resp.server_infos[0].system_info.network_info_list[0].interface_name #=> String
resp.server_infos[0].system_info.network_info_list[0].ip_address #=> String
resp.server_infos[0].system_info.network_info_list[0].mac_address #=> String
resp.server_infos[0].system_info.network_info_list[0].net_mask #=> String
resp.server_infos[0].system_info.os_info.type #=> String, one of "LINUX", "WINDOWS"
resp.server_infos[0].system_info.os_info.version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filter_value (String) —

    Specifies the filter value, which is based on the type of server criteria. For example, if ‘serverCriteria` is `OS_NAME`, and the `filterValue` is equal to `WindowsServer`, then `ListServers` returns all of the servers matching the OS name `WindowsServer`.

  • :group_id_filter (Array<Types::Group>) —

    Specifies the group ID to filter on.

  • :max_results (Integer) —

    The maximum number of items to include in the response. The maximum value is 100.

  • :next_token (String) —

    The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set ‘maxResults` to 10. You’ll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

  • :server_criteria (String) —

    Criteria for filtering servers.

  • :sort (String) —

    Specifies whether to sort by ascending (‘ASC`) or descending (`DESC`) order.

Returns:

See Also:



1286
1287
1288
1289
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 1286

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

#put_portfolio_preferences(params = {}) ⇒ Struct

Saves the specified migration and modernization preferences.

Examples:

Request syntax with placeholder values


resp = client.put_portfolio_preferences({
  application_mode: "ALL", # accepts ALL, KNOWN, UNKNOWN
  application_preferences: {
    management_preference: {
      aws_managed_resources: {
        target_destination: ["None specified"], # required, accepts None specified, AWS Elastic BeanStalk, AWS Fargate
      },
      no_preference: {
        target_destination: ["None specified"], # required, accepts None specified, AWS Elastic BeanStalk, AWS Fargate, Amazon Elastic Cloud Compute (EC2), Amazon Elastic Container Service (ECS), Amazon Elastic Kubernetes Service (EKS)
      },
      self_manage_resources: {
        target_destination: ["None specified"], # required, accepts None specified, Amazon Elastic Cloud Compute (EC2), Amazon Elastic Container Service (ECS), Amazon Elastic Kubernetes Service (EKS)
      },
    },
  },
  database_preferences: {
    database_management_preference: "AWS-managed", # accepts AWS-managed, Self-manage, No preference
    database_migration_preference: {
      heterogeneous: {
        target_database_engine: ["None specified"], # required, accepts None specified, Amazon Aurora, AWS PostgreSQL, MySQL, Microsoft SQL Server, Oracle Database, MariaDB, SAP, Db2 LUW, MongoDB
      },
      homogeneous: {
        target_database_engine: ["None specified"], # accepts None specified
      },
      no_preference: {
        target_database_engine: ["None specified"], # required, accepts None specified, Amazon Aurora, AWS PostgreSQL, MySQL, Microsoft SQL Server, Oracle Database, MariaDB, SAP, Db2 LUW, MongoDB
      },
    },
  },
  prioritize_business_goals: {
    business_goals: {
      license_cost_reduction: 1,
      modernize_infrastructure_with_cloud_native_technologies: 1,
      reduce_operational_overhead_with_managed_services: 1,
      speed_of_migration: 1,
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :application_mode (String) —

    The classification for application component types.

  • :application_preferences (Types::ApplicationPreferences) —

    The transformation preferences for non-database applications.

  • :database_preferences (Types::DatabasePreferences) —

    The transformation preferences for database applications.

  • :prioritize_business_goals (Types::PrioritizeBusinessGoals) —

    The rank of the business goals based on priority.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1352
1353
1354
1355
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 1352

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

#start_assessment(params = {}) ⇒ Types::StartAssessmentResponse

Starts the assessment of an on-premises environment.

Examples:

Request syntax with placeholder values


resp = client.start_assessment({
  assessment_data_source_type: "StrategyRecommendationsApplicationDataCollector", # accepts StrategyRecommendationsApplicationDataCollector, ManualImport, ApplicationDiscoveryService
  assessment_targets: [
    {
      condition: "EQUALS", # required, accepts EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS
      name: "String", # required
      values: ["String"], # required
    },
  ],
  s3bucket_for_analysis_data: "StartAssessmentRequestS3bucketForAnalysisDataString",
  s3bucket_for_report_data: "StartAssessmentRequestS3bucketForReportDataString",
})

Response structure


resp.assessment_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :assessment_data_source_type (String) —

    The data source type of an assessment to be started.

  • :assessment_targets (Array<Types::AssessmentTarget>) —

    List of criteria for assessment.

  • :s3bucket_for_analysis_data (String) —

    The S3 bucket used by the collectors to send analysis data to the service. The bucket name must begin with ‘migrationhub-strategy-`.

  • :s3bucket_for_report_data (String) —

    The S3 bucket where all the reports generated by the service are stored. The bucket name must begin with ‘migrationhub-strategy-`.

Returns:

See Also:



1400
1401
1402
1403
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 1400

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

#start_import_file_task(params = {}) ⇒ Types::StartImportFileTaskResponse

Starts a file import.

Examples:

Request syntax with placeholder values


resp = client.start_import_file_task({
  s3_bucket: "importS3Bucket", # required
  data_source_type: "ApplicationDiscoveryService", # accepts ApplicationDiscoveryService, MPA, Import, StrategyRecommendationsApplicationDataCollector
  group_id: [
    {
      name: "ExternalId", # accepts ExternalId, ExternalSourceType
      value: "String",
    },
  ],
  name: "StartImportFileTaskRequestNameString", # required
  s3bucket_for_report_data: "StartImportFileTaskRequestS3bucketForReportDataString",
  s3key: "String", # required
})

Response structure


resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :s3_bucket (required, String) —

    The S3 bucket where the import file is located. The bucket name is required to begin with ‘migrationhub-strategy-`.

  • :data_source_type (String) —

    Specifies the source that the servers are coming from. By default, Strategy Recommendations assumes that the servers specified in the import file are available in AWS Application Discovery Service.

  • :group_id (Array<Types::Group>) —

    Groups the resources in the import file together with a unique name. This ID can be as filter in ‘ListApplicationComponents` and `ListServers`.

  • :name (required, String) —

    A descriptive name for the request.

  • :s3bucket_for_report_data (String) —

    The S3 bucket where Strategy Recommendations uploads import results. The bucket name is required to begin with migrationhub-strategy-.

  • :s3key (required, String) —

    The Amazon S3 key name of the import file.

Returns:

See Also:



1459
1460
1461
1462
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 1459

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

#start_recommendation_report_generation(params = {}) ⇒ Types::StartRecommendationReportGenerationResponse

Starts generating a recommendation report.

Examples:

Request syntax with placeholder values


resp = client.start_recommendation_report_generation({
  group_id_filter: [
    {
      name: "ExternalId", # accepts ExternalId, ExternalSourceType
      value: "String",
    },
  ],
  output_format: "Excel", # accepts Excel, Json
})

Response structure


resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :group_id_filter (Array<Types::Group>) —

    Groups the resources in the recommendation report with a unique name.

  • :output_format (String) —

    The output format for the recommendation report file. The default format is Microsoft Excel.

Returns:

See Also:



1497
1498
1499
1500
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 1497

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

#stop_assessment(params = {}) ⇒ Struct

Stops the assessment of an on-premises environment.

Examples:

Request syntax with placeholder values


resp = client.stop_assessment({
  assessment_id: "AsyncTaskId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :assessment_id (required, String) —

    The ‘assessmentId` returned by StartAssessment.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1519
1520
1521
1522
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 1519

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

#update_application_component_config(params = {}) ⇒ Struct

Updates the configuration of an application component.

Examples:

Request syntax with placeholder values


resp = client.update_application_component_config({
  app_type: "DotNetFramework", # accepts DotNetFramework, Java, SQLServer, IIS, Oracle, Other, Tomcat, JBoss, Spring, Mongo DB, DB2, Maria DB, MySQL, Sybase, PostgreSQLServer, Cassandra, IBM WebSphere, Oracle WebLogic, Visual Basic, Unknown, DotnetCore, Dotnet
  application_component_id: "ApplicationComponentId", # required
  configure_only: false,
  inclusion_status: "excludeFromAssessment", # accepts excludeFromAssessment, includeInAssessment
  secrets_manager_key: "SecretsManagerKey",
  source_code_list: [
    {
      location: "Location",
      project_name: "ProjectName",
      source_version: "SourceVersion",
      version_control: "GITHUB", # accepts GITHUB, GITHUB_ENTERPRISE, AZURE_DEVOPS_GIT
    },
  ],
  strategy_option: {
    is_preferred: false,
    strategy: "Rehost", # accepts Rehost, Retirement, Refactor, Replatform, Retain, Relocate, Repurchase
    target_destination: "None specified", # accepts None specified, AWS Elastic BeanStalk, AWS Fargate, Amazon Elastic Cloud Compute (EC2), Amazon Elastic Container Service (ECS), Amazon Elastic Kubernetes Service (EKS), Aurora MySQL, Aurora PostgreSQL, Amazon Relational Database Service on MySQL, Amazon Relational Database Service on PostgreSQL, Amazon DocumentDB, Amazon DynamoDB, Amazon Relational Database Service, Babelfish for Aurora PostgreSQL
    tool_name: "App2Container", # accepts App2Container, Porting Assistant For .NET, End of Support Migration, Windows Web Application Migration Assistant, Application Migration Service, Strategy Recommendation Support, In Place Operating System Upgrade, Schema Conversion Tool, Database Migration Service, Native SQL Server Backup/Restore
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :app_type (String) —

    The type of known component.

  • :application_component_id (required, String) —

    The ID of the application component. The ID is unique within an AWS account.

  • :configure_only (Boolean) —

    Update the configuration request of an application component. If it is set to true, the source code and/or database credentials are updated. If it is set to false, the source code and/or database credentials are updated and an analysis is initiated.

  • :inclusion_status (String) —

    Indicates whether the application component has been included for server recommendation or not.

  • :secrets_manager_key (String) —

    Database credentials.

  • :source_code_list (Array<Types::SourceCode>) —

    The list of source code configurations to update for the application component.

  • :strategy_option (Types::StrategyOption) —

    The preferred strategy options for the application component. Use values from the GetApplicationComponentStrategies response.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1584
1585
1586
1587
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 1584

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

#update_server_config(params = {}) ⇒ Struct

Updates the configuration of the specified server.

Examples:

Request syntax with placeholder values


resp = client.update_server_config({
  server_id: "ServerId", # required
  strategy_option: {
    is_preferred: false,
    strategy: "Rehost", # accepts Rehost, Retirement, Refactor, Replatform, Retain, Relocate, Repurchase
    target_destination: "None specified", # accepts None specified, AWS Elastic BeanStalk, AWS Fargate, Amazon Elastic Cloud Compute (EC2), Amazon Elastic Container Service (ECS), Amazon Elastic Kubernetes Service (EKS), Aurora MySQL, Aurora PostgreSQL, Amazon Relational Database Service on MySQL, Amazon Relational Database Service on PostgreSQL, Amazon DocumentDB, Amazon DynamoDB, Amazon Relational Database Service, Babelfish for Aurora PostgreSQL
    tool_name: "App2Container", # accepts App2Container, Porting Assistant For .NET, End of Support Migration, Windows Web Application Migration Assistant, Application Migration Service, Strategy Recommendation Support, In Place Operating System Upgrade, Schema Conversion Tool, Database Migration Service, Native SQL Server Backup/Restore
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :server_id (required, String) —

    The ID of the server.

  • :strategy_option (Types::StrategyOption) —

    The preferred strategy options for the application component. See the response from GetServerStrategies.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1616
1617
1618
1619
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 1616

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1645
1646
1647
 
# File 'lib/aws-sdk-migrationhubstrategyrecommendations/client.rb', line 1645

def waiter_names
  []
end