You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.MigrationHubStrategy

Inherits:
AWS.Service show all
Identifier:
migrationhubstrategy
API Version:
2020-02-19
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

 <p>This API reference provides descriptions, syntax, and other details about each of the actions and data types for Migration Hub Strategy Recommendations (Strategy Recommendations). The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see <a href="http://aws.amazon.com/tools/#SDKs&quot;&gt;AWS SDKs</a>.</p> 

Sending a Request Using MigrationHubStrategy

var migrationhubstrategy = new AWS.MigrationHubStrategy();
migrationhubstrategy.getApplicationComponentDetails(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the MigrationHubStrategy object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var migrationhubstrategy = new AWS.MigrationHubStrategy({apiVersion: '2020-02-19'});

You can also set the API version globally in AWS.config.apiVersions using the migrationhubstrategy service identifier:

AWS.config.apiVersions = {
  migrationhubstrategy: '2020-02-19',
  // other service API versions
};

var migrationhubstrategy = new AWS.MigrationHubStrategy();

Version:

  • 2020-02-19

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.MigrationHubStrategy(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a MigrationHubStrategy object

var migrationhubstrategy = new AWS.MigrationHubStrategy({apiVersion: '2020-02-19'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.MigrationHubStrategy.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.MigrationHubStrategy.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.MigrationHubStrategy.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

getApplicationComponentDetails(params = {}, callback) ⇒ AWS.Request

Retrieves details about an application component.

Service Reference:

Examples:

Calling the getApplicationComponentDetails operation

var params = {
  applicationComponentId: 'STRING_VALUE' /* required */
};
migrationhubstrategy.getApplicationComponentDetails(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationComponentId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • applicationComponentDetail — (map)

        Detailed information about an application component.

        • analysisStatus — (String)

          The status of analysis, if the application component has source code or an associated database.

          Possible values include:
          • "ANALYSIS_TO_BE_SCHEDULED"
          • "ANALYSIS_STARTED"
          • "ANALYSIS_SUCCESS"
          • "ANALYSIS_FAILED"
        • antipatternReportS3Object — (map)

          The S3 bucket name and the Amazon S3 key name for the anti-pattern report.

          • s3Bucket — (String)

            The S3 bucket name.

          • s3key — (String)

            The Amazon S3 key name.

        • antipatternReportStatus — (String)

          The status of the anti-pattern report generation.

          Possible values include:
          • "FAILED"
          • "IN_PROGRESS"
          • "SUCCESS"
        • antipatternReportStatusMessage — (String)

          The status message for the anti-pattern.

        • appType — (String)

          The type of application component.

          Possible values include:
          • "DotNetFramework"
          • "Java"
          • "SQLServer"
          • "IIS"
          • "Oracle"
          • "Other"
        • associatedServerId — (String)

          The ID of the server that the application component is running on.

        • databaseConfigDetail — (map)

          Configuration details for the database associated with the application component.

          • secretName — (String)

            AWS Secrets Manager key that holds the credentials that you use to connect to a database.

        • id — (String)

          The ID of the application component.

        • inclusionStatus — (String)

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

          Possible values include:
          • "excludeFromAssessment"
          • "includeInAssessment"
        • lastAnalyzedTimestamp — (Date)

          The timestamp of when the application component was assessed.

        • listAntipatternSeveritySummary — (Array<map>)

          A list of anti-pattern severity summaries.

          • count — (Integer)

            Contains the count of anti-patterns.

          • severity — (String)

            Contains the severity of anti-patterns.

            Possible values include:
            • "HIGH"
            • "MEDIUM"
            • "LOW"
        • moreServerAssociationExists — (Boolean)

          Set to true if the application component is running on multiple servers.

        • name — (String)

          The name of application component.

        • osDriver — (String)

          OS driver.

        • osVersion — (String)

          OS version.

        • recommendationSet — (map)

          The top recommendation set for the application component.

          • strategy — (String)

            The recommended strategy.

            Possible values include:
            • "Rehost"
            • "Retirement"
            • "Refactor"
            • "Replatform"
            • "Retain"
            • "Relocate"
            • "Repurchase"
          • targetDestination — (String)

            The recommended target destination.

            Possible values include:
            • "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"
          • transformationTool — (map)

            The target destination for the recommendation set.

            • description — (String)

              Description of the tool.

            • name — (String)

              Name of the tool.

              Possible values include:
              • "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"
            • tranformationToolInstallationLink — (String)

              URL for installing the tool.

        • resourceSubType — (String)

          The application component subtype.

          Possible values include:
          • "Database"
          • "Process"
          • "DatabaseProcess"
        • sourceCodeRepositories — (Array<map>)

          Details about the source code repository associated with the application component.

          • branch — (String)

            The branch of the source code.

          • repository — (String)

            The repository name for the source code.

          • versionControlType — (String)

            The type of repository to use for the source code.

        • statusMessage — (String)

          A detailed description of the analysis status and any failure message.

      • associatedApplications — (Array<map>)

        The associated application group as defined in AWS Application Discovery Service.

        • id — (String)

          ID of the application as defined in Application Discovery Service.

        • name — (String)

          Name of the application as defined in Application Discovery Service.

      • associatedServerIds — (Array<String>)

        A list of the IDs of the servers on which the application component is running.

      • moreApplicationResource — (Boolean)

        Set to true if the application component belongs to more than one application group.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getApplicationComponentStrategies(params = {}, callback) ⇒ AWS.Request

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

Examples:

Calling the getApplicationComponentStrategies operation

var params = {
  applicationComponentId: 'STRING_VALUE' /* required */
};
migrationhubstrategy.getApplicationComponentStrategies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationComponentId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • applicationComponentStrategies — (Array<map>)

        A list of application component strategy recommendations.

        • isPreferred — (Boolean)

          Set to true if the recommendation is set as preferred.

        • recommendation — (map)

          Strategy recommendation for the application component.

          • strategy — (String)

            The recommended strategy.

            Possible values include:
            • "Rehost"
            • "Retirement"
            • "Refactor"
            • "Replatform"
            • "Retain"
            • "Relocate"
            • "Repurchase"
          • targetDestination — (String)

            The recommended target destination.

            Possible values include:
            • "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"
          • transformationTool — (map)

            The target destination for the recommendation set.

            • description — (String)

              Description of the tool.

            • name — (String)

              Name of the tool.

              Possible values include:
              • "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"
            • tranformationToolInstallationLink — (String)

              URL for installing the tool.

        • status — (String)

          The recommendation status of a strategy for an application component.

          Possible values include:
          • "recommended"
          • "viableOption"
          • "notRecommended"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getAssessment(params = {}, callback) ⇒ AWS.Request

Retrieves the status of an on-going assessment.

Service Reference:

Examples:

Calling the getAssessment operation

var params = {
  id: 'STRING_VALUE' /* required */
};
migrationhubstrategy.getAssessment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • dataCollectionDetails — (map)

        Detailed information about the assessment.

        • completionTime — (Date)

          The time the assessment completes.

        • failed — (Integer)

          The number of failed servers in the assessment.

        • inProgress — (Integer)

          The number of servers with the assessment status IN_PROGESS.

        • servers — (Integer)

          The total number of servers in the assessment.

        • startTime — (Date)

          The start time of assessment.

        • status — (String)

          The status of the assessment.

          Possible values include:
          • "IN_PROGRESS"
          • "COMPLETE"
          • "FAILED"
          • "STOPPED"
        • success — (Integer)

          The number of successful servers in the assessment.

      • id — (String)

        The ID for the specific assessment task.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getImportFileTask(params = {}, callback) ⇒ AWS.Request

Retrieves the details about a specific import task.

Service Reference:

Examples:

Calling the getImportFileTask operation

var params = {
  id: 'STRING_VALUE' /* required */
};
migrationhubstrategy.getImportFileTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • id — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • completionTime — (Date)

        The time that the import task completed.

      • id — (String)

        The import file task id returned in the response of StartImportFileTask.

      • importName — (String)

        The name of the import task given in StartImportFileTask.

      • inputS3Bucket — (String)

        The S3 bucket where import file is located.

      • inputS3Key — (String)

        The Amazon S3 key name of the import file.

      • numberOfRecordsFailed — (Integer)

        The number of records that failed to be imported.

      • numberOfRecordsSuccess — (Integer)

        The number of records successfully imported.

      • startTime — (Date)

        Start time of the import task.

      • status — (String)

        Status of import file task.

        Possible values include:
        • "ImportInProgress"
        • "ImportFailed"
        • "ImportPartialSuccess"
        • "ImportSuccess"
        • "DeleteInProgress"
        • "DeleteFailed"
        • "DeletePartialSuccess"
        • "DeleteSuccess"
      • statusReportS3Bucket — (String)

        The S3 bucket name for status report of import task.

      • statusReportS3Key — (String)

        The Amazon S3 key name for status report of import task. The report contains details about whether each record imported successfully or why it did not.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getPortfolioPreferences(params = {}, callback) ⇒ AWS.Request

Retrieves your migration and modernization preferences.

Service Reference:

Examples:

Calling the getPortfolioPreferences operation

var params = {
};
migrationhubstrategy.getPortfolioPreferences(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • applicationPreferences — (map)

        The transformation preferences for non-database applications.

        • managementPreference — (map)

          Application preferences that you specify to prefer managed environment.

          • awsManagedResources — (map)

            Indicates interest in solutions that are managed by AWS.

            • targetDestinationrequired — (Array<String>)

              The choice of application destination that you specify.

          • noPreference — (map)

            No specific preference.

            • targetDestinationrequired — (Array<String>)

              The choice of application destination that you specify.

          • selfManageResources — (map)

            Indicates interest in managing your own resources on AWS.

            • targetDestinationrequired — (Array<String>)

              Self-managed resources target destination.

      • databasePreferences — (map)

        The transformation preferences for database applications.

        • databaseManagementPreference — (String)

          Specifies whether you're interested in self-managed databases or databases managed by AWS.

          Possible values include:
          • "AWS-managed"
          • "Self-manage"
          • "No preference"
        • databaseMigrationPreference — (map)

          Specifies your preferred migration path.

          • heterogeneous — (map)

            Indicates whether you are interested in moving from one type of database to another. For example, from SQL Server to Amazon Aurora MySQL-Compatible Edition.

            • targetDatabaseEnginerequired — (Array<String>)

              The target database engine for heterogeneous database migration preference.

          • homogeneous — (map)

            Indicates whether you are interested in moving to the same type of database into AWS. For example, from SQL Server in your environment to SQL Server on AWS.

            • targetDatabaseEngine — (Array<String>)

              The target database engine for homogeneous database migration preferences.

          • noPreference — (map)

            Indicated that you do not prefer heterogeneous or homogeneous.

            • targetDatabaseEnginerequired — (Array<String>)

              The target database engine for database migration preference that you specify.

      • prioritizeBusinessGoals — (map)

        The rank of business goals based on priority.

        • businessGoals — (map)

          Rank of business goals based on priority.

          • licenseCostReduction — (Integer)

            Business goal to reduce license costs.

          • modernizeInfrastructureWithCloudNativeTechnologies — (Integer)

            Business goal to modernize infrastructure by moving to cloud native technologies.

          • reduceOperationalOverheadWithManagedServices — (Integer)

            Business goal to reduce the operational overhead on the team by moving into managed services.

          • speedOfMigration — (Integer)

            Business goal to achieve migration at a fast pace.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getPortfolioSummary(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getPortfolioSummary operation

var params = {
};
migrationhubstrategy.getPortfolioSummary(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • assessmentSummary — (map)

        An assessment summary for the portfolio including the number of servers to rehost and the overall number of anti-patterns.

        • antipatternReportS3Object — (map)

          The Amazon S3 object containing the anti-pattern report.

          • s3Bucket — (String)

            The S3 bucket name.

          • s3key — (String)

            The Amazon S3 key name.

        • antipatternReportStatus — (String)

          The status of the anti-pattern report.

          Possible values include:
          • "FAILED"
          • "IN_PROGRESS"
          • "SUCCESS"
        • antipatternReportStatusMessage — (String)

          The status message of the anti-pattern report.

        • lastAnalyzedTimestamp — (Date)

          The time the assessment was performed.

        • listAntipatternSeveritySummary — (Array<map>)

          List of AntipatternSeveritySummary.

          • count — (Integer)

            Contains the count of anti-patterns.

          • severity — (String)

            Contains the severity of anti-patterns.

            Possible values include:
            • "HIGH"
            • "MEDIUM"
            • "LOW"
        • listApplicationComponentStrategySummary — (Array<map>)

          List of ApplicationComponentStrategySummary.

          • count — (Integer)

            The count of recommendations per strategy.

          • strategy — (String)

            The name of recommended strategy.

            Possible values include:
            • "Rehost"
            • "Retirement"
            • "Refactor"
            • "Replatform"
            • "Retain"
            • "Relocate"
            • "Repurchase"
        • listApplicationComponentSummary — (Array<map>)

          List of ApplicationComponentSummary.

          • appType — (String)

            Contains the name of application types.

            Possible values include:
            • "DotNetFramework"
            • "Java"
            • "SQLServer"
            • "IIS"
            • "Oracle"
            • "Other"
          • count — (Integer)

            Contains the count of application type.

        • listServerStrategySummary — (Array<map>)

          List of ServerStrategySummary.

          • count — (Integer)

            The count of recommendations per strategy.

          • strategy — (String)

            The name of recommended strategy.

            Possible values include:
            • "Rehost"
            • "Retirement"
            • "Refactor"
            • "Replatform"
            • "Retain"
            • "Relocate"
            • "Repurchase"
        • listServerSummary — (Array<map>)

          List of ServerSummary.

          • ServerOsType — (String)

            Type of operating system for the servers.

            Possible values include:
            • "WindowsServer"
            • "AmazonLinux"
            • "EndOfSupportWindowsServer"
            • "Redhat"
            • "Other"
          • count — (Integer)

            Number of servers.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getRecommendationReportDetails(params = {}, callback) ⇒ AWS.Request

Retrieves detailed information about the specified recommendation report.

Service Reference:

Examples:

Calling the getRecommendationReportDetails operation

var params = {
  id: 'STRING_VALUE' /* required */
};
migrationhubstrategy.getRecommendationReportDetails(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • id — (String)

        The ID of the recommendation report generation task. See the response of StartRecommendationReportGeneration.

      • recommendationReportDetails — (map)

        Detailed information about the recommendation report.

        • completionTime — (Date)

          The time that the recommendation report generation task completes.

        • s3Bucket — (String)

          The S3 bucket where the report file is located.

        • s3Keys — (Array<String>)

          The Amazon S3 key name of the report file.

        • startTime — (Date)

          The time that the recommendation report generation task starts.

        • status — (String)

          The status of the recommendation report generation task.

          Possible values include:
          • "FAILED"
          • "IN_PROGRESS"
          • "SUCCESS"
        • statusMessage — (String)

          The status message for recommendation report generation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getServerDetails(params = {}, callback) ⇒ AWS.Request

Retrieves detailed information about a specified server.

Service Reference:

Examples:

Calling the getServerDetails operation

var params = {
  serverId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
migrationhubstrategy.getServerDetails(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

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

    • nextToken — (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.

    • serverId — (String)

      The ID of the server.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • associatedApplications — (Array<map>)

        The associated application group the server belongs to, as defined in AWS Application Discovery Service.

        • id — (String)

          ID of the application as defined in Application Discovery Service.

        • name — (String)

          Name of the application as defined in Application Discovery Service.

      • nextToken — (String)

        The token you use to retrieve the next set of results, or null if there are no more results.

      • serverDetail — (map)

        Detailed information about the server.

        • antipatternReportS3Object — (map)

          The S3 bucket name and Amazon S3 key name for anti-pattern report.

          • s3Bucket — (String)

            The S3 bucket name.

          • s3key — (String)

            The Amazon S3 key name.

        • antipatternReportStatus — (String)

          The status of the anti-pattern report generation.

          Possible values include:
          • "FAILED"
          • "IN_PROGRESS"
          • "SUCCESS"
        • antipatternReportStatusMessage — (String)

          A message about the status of the anti-pattern report generation.

        • applicationComponentStrategySummary — (Array<map>)

          A list of strategy summaries.

          • count — (Integer)

            The count of recommendations per strategy.

          • strategy — (String)

            The name of recommended strategy.

            Possible values include:
            • "Rehost"
            • "Retirement"
            • "Refactor"
            • "Replatform"
            • "Retain"
            • "Relocate"
            • "Repurchase"
        • dataCollectionStatus — (String)

          The status of assessment for the server.

          Possible values include:
          • "dataCollectionTaskToBeScheduled"
          • "dataCollectionTaskScheduled"
          • "dataCollectionTaskStarted"
          • "dataCollectionTaskStopped"
          • "dataCollectionTaskSuccess"
          • "dataCollectionTaskFailed"
          • "dataCollectionTaskPartialSuccess"
        • id — (String)

          The server ID.

        • lastAnalyzedTimestamp — (Date)

          The timestamp of when the server was assessed.

        • listAntipatternSeveritySummary — (Array<map>)

          A list of anti-pattern severity summaries.

          • count — (Integer)

            Contains the count of anti-patterns.

          • severity — (String)

            Contains the severity of anti-patterns.

            Possible values include:
            • "HIGH"
            • "MEDIUM"
            • "LOW"
        • name — (String)

          The name of the server.

        • recommendationSet — (map)

          A set of recommendations.

          • strategy — (String)

            The recommended strategy.

            Possible values include:
            • "Rehost"
            • "Retirement"
            • "Refactor"
            • "Replatform"
            • "Retain"
            • "Relocate"
            • "Repurchase"
          • targetDestination — (String)

            The recommended target destination.

            Possible values include:
            • "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"
          • transformationTool — (map)

            The target destination for the recommendation set.

            • description — (String)

              Description of the tool.

            • name — (String)

              Name of the tool.

              Possible values include:
              • "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"
            • tranformationToolInstallationLink — (String)

              URL for installing the tool.

        • serverType — (String)

          The type of server.

        • statusMessage — (String)

          A message about the status of data collection, which contains detailed descriptions of any error messages.

        • systemInfo — (map)

          System information about the server.

          • cpuArchitecture — (String)

            CPU architecture type for the server.

          • fileSystemType — (String)

            File system type for the server.

          • networkInfoList — (Array<map>)

            Networking information related to a server.

            • interfaceNamerequired — (String)

              Information about the name of the interface of the server for which the assessment was run.

            • ipAddressrequired — (String)

              Information about the IP address of the server for which the assessment was run.

            • macAddressrequired — (String)

              Information about the MAC address of the server for which the assessment was run.

            • netMaskrequired — (String)

              Information about the subnet mask of the server for which the assessment was run.

          • osInfo — (map)

            Operating system corresponding to a server.

            • type — (String)

              Information about the type of operating system.

              Possible values include:
              • "LINUX"
              • "WINDOWS"
            • version — (String)

              Information about the version of operating system.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getServerStrategies(params = {}, callback) ⇒ AWS.Request

Retrieves recommended strategies and tools for the specified server.

Service Reference:

Examples:

Calling the getServerStrategies operation

var params = {
  serverId: 'STRING_VALUE' /* required */
};
migrationhubstrategy.getServerStrategies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • serverId — (String)

      The ID of the server.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • serverStrategies — (Array<map>)

        A list of strategy recommendations for the server.

        • isPreferred — (Boolean)

          Set to true if the recommendation is set as preferred.

        • numberOfApplicationComponents — (Integer)

          The number of application components with this strategy recommendation running on the server.

        • recommendation — (map)

          Strategy recommendation for the server.

          • strategy — (String)

            The recommended strategy.

            Possible values include:
            • "Rehost"
            • "Retirement"
            • "Refactor"
            • "Replatform"
            • "Retain"
            • "Relocate"
            • "Repurchase"
          • targetDestination — (String)

            The recommended target destination.

            Possible values include:
            • "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"
          • transformationTool — (map)

            The target destination for the recommendation set.

            • description — (String)

              Description of the tool.

            • name — (String)

              Name of the tool.

              Possible values include:
              • "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"
            • tranformationToolInstallationLink — (String)

              URL for installing the tool.

        • status — (String)

          The recommendation status of the strategy for the server.

          Possible values include:
          • "recommended"
          • "viableOption"
          • "notRecommended"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listApplicationComponents(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listApplicationComponents operation

var params = {
  applicationComponentCriteria: NOT_DEFINED | APP_NAME | SERVER_ID | APP_TYPE | STRATEGY | DESTINATION,
  filterValue: 'STRING_VALUE',
  groupIdFilter: [
    {
      name: ExternalId,
      value: 'STRING_VALUE'
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sort: ASC | DESC
};
migrationhubstrategy.listApplicationComponents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationComponentCriteria — (String)

      Criteria for filtering the list of application components.

      Possible values include:
      • "NOT_DEFINED"
      • "APP_NAME"
      • "SERVER_ID"
      • "APP_TYPE"
      • "STRATEGY"
      • "DESTINATION"
    • filterValue — (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.

    • groupIdFilter — (Array<map>)

      The group ID specified in to filter on.

      • name — (String)

        The key of the specific import group.

        Possible values include:
        • "ExternalId"
      • value — (String)

        The value of the specific import group.

    • maxResults — (Integer)

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

    • nextToken — (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.

      Possible values include:
      • "ASC"
      • "DESC"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • applicationComponentInfos — (Array<map>)

        The list of application components with detailed information about each component.

        • analysisStatus — (String)

          The status of analysis, if the application component has source code or an associated database.

          Possible values include:
          • "ANALYSIS_TO_BE_SCHEDULED"
          • "ANALYSIS_STARTED"
          • "ANALYSIS_SUCCESS"
          • "ANALYSIS_FAILED"
        • antipatternReportS3Object — (map)

          The S3 bucket name and the Amazon S3 key name for the anti-pattern report.

          • s3Bucket — (String)

            The S3 bucket name.

          • s3key — (String)

            The Amazon S3 key name.

        • antipatternReportStatus — (String)

          The status of the anti-pattern report generation.

          Possible values include:
          • "FAILED"
          • "IN_PROGRESS"
          • "SUCCESS"
        • antipatternReportStatusMessage — (String)

          The status message for the anti-pattern.

        • appType — (String)

          The type of application component.

          Possible values include:
          • "DotNetFramework"
          • "Java"
          • "SQLServer"
          • "IIS"
          • "Oracle"
          • "Other"
        • associatedServerId — (String)

          The ID of the server that the application component is running on.

        • databaseConfigDetail — (map)

          Configuration details for the database associated with the application component.

          • secretName — (String)

            AWS Secrets Manager key that holds the credentials that you use to connect to a database.

        • id — (String)

          The ID of the application component.

        • inclusionStatus — (String)

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

          Possible values include:
          • "excludeFromAssessment"
          • "includeInAssessment"
        • lastAnalyzedTimestamp — (Date)

          The timestamp of when the application component was assessed.

        • listAntipatternSeveritySummary — (Array<map>)

          A list of anti-pattern severity summaries.

          • count — (Integer)

            Contains the count of anti-patterns.

          • severity — (String)

            Contains the severity of anti-patterns.

            Possible values include:
            • "HIGH"
            • "MEDIUM"
            • "LOW"
        • moreServerAssociationExists — (Boolean)

          Set to true if the application component is running on multiple servers.

        • name — (String)

          The name of application component.

        • osDriver — (String)

          OS driver.

        • osVersion — (String)

          OS version.

        • recommendationSet — (map)

          The top recommendation set for the application component.

          • strategy — (String)

            The recommended strategy.

            Possible values include:
            • "Rehost"
            • "Retirement"
            • "Refactor"
            • "Replatform"
            • "Retain"
            • "Relocate"
            • "Repurchase"
          • targetDestination — (String)

            The recommended target destination.

            Possible values include:
            • "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"
          • transformationTool — (map)

            The target destination for the recommendation set.

            • description — (String)

              Description of the tool.

            • name — (String)

              Name of the tool.

              Possible values include:
              • "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"
            • tranformationToolInstallationLink — (String)

              URL for installing the tool.

        • resourceSubType — (String)

          The application component subtype.

          Possible values include:
          • "Database"
          • "Process"
          • "DatabaseProcess"
        • sourceCodeRepositories — (Array<map>)

          Details about the source code repository associated with the application component.

          • branch — (String)

            The branch of the source code.

          • repository — (String)

            The repository name for the source code.

          • versionControlType — (String)

            The type of repository to use for the source code.

        • statusMessage — (String)

          A detailed description of the analysis status and any failure message.

      • nextToken — (String)

        The token you use to retrieve the next set of results, or null if there are no more results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listCollectors(params = {}, callback) ⇒ AWS.Request

Retrieves a list of all the installed collectors.

Service Reference:

Examples:

Calling the listCollectors operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
migrationhubstrategy.listCollectors(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

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

    • nextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Collectors — (Array<map>)

        The list of all the installed collectors.

        • collectorHealth — (String)

          Indicates the health of a collector.

          Possible values include:
          • "COLLECTOR_HEALTHY"
          • "COLLECTOR_UNHEALTHY"
        • collectorId — (String)

          The ID of the collector.

        • collectorVersion — (String)

          Current version of the collector that is running in the environment that you specify.

        • hostName — (String)

          Hostname of the server that is hosting the collector.

        • ipAddress — (String)

          IP address of the server that is hosting the collector.

        • lastActivityTimeStamp — (String)

          Time when the collector last pinged the service.

        • registeredTimeStamp — (String)

          Time when the collector registered with the service.

      • nextToken — (String)

        The token you use to retrieve the next set of results, or null if there are no more results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listImportFileTask(params = {}, callback) ⇒ AWS.Request

Retrieves a list of all the imports performed.

Service Reference:

Examples:

Calling the listImportFileTask operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
migrationhubstrategy.listImportFileTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

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

    • nextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        The token you use to retrieve the next set of results, or null if there are no more results.

      • taskInfos — (Array<map>)

        Lists information about the files you import.

        • completionTime — (Date)

          The time that the import task completes.

        • id — (String)

          The ID of the import file task.

        • importName — (String)

          The name of the import task given in StartImportFileTask.

        • inputS3Bucket — (String)

          The S3 bucket where the import file is located.

        • inputS3Key — (String)

          The Amazon S3 key name of the import file.

        • numberOfRecordsFailed — (Integer)

          The number of records that failed to be imported.

        • numberOfRecordsSuccess — (Integer)

          The number of records successfully imported.

        • startTime — (Date)

          Start time of the import task.

        • status — (String)

          Status of import file task.

          Possible values include:
          • "ImportInProgress"
          • "ImportFailed"
          • "ImportPartialSuccess"
          • "ImportSuccess"
          • "DeleteInProgress"
          • "DeleteFailed"
          • "DeletePartialSuccess"
          • "DeleteSuccess"
        • statusReportS3Bucket — (String)

          The S3 bucket name for status report of import task.

        • statusReportS3Key — (String)

          The Amazon S3 key name for status report of import task. The report contains details about whether each record imported successfully or why it did not.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listServers(params = {}, callback) ⇒ AWS.Request

Returns a list of all the servers.

Service Reference:

Examples:

Calling the listServers operation

var params = {
  filterValue: 'STRING_VALUE',
  groupIdFilter: [
    {
      name: ExternalId,
      value: 'STRING_VALUE'
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  serverCriteria: NOT_DEFINED | OS_NAME | STRATEGY | DESTINATION | SERVER_ID,
  sort: ASC | DESC
};
migrationhubstrategy.listServers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • filterValue — (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.

    • groupIdFilter — (Array<map>)

      Specifies the group ID to filter on.

      • name — (String)

        The key of the specific import group.

        Possible values include:
        • "ExternalId"
      • value — (String)

        The value of the specific import group.

    • maxResults — (Integer)

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

    • nextToken — (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.

    • serverCriteria — (String)

      Criteria for filtering servers.

      Possible values include:
      • "NOT_DEFINED"
      • "OS_NAME"
      • "STRATEGY"
      • "DESTINATION"
      • "SERVER_ID"
    • sort — (String)

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

      Possible values include:
      • "ASC"
      • "DESC"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        The token you use to retrieve the next set of results, or null if there are no more results.

      • serverInfos — (Array<map>)

        The list of servers with detailed information about each server.

        • antipatternReportS3Object — (map)

          The S3 bucket name and Amazon S3 key name for anti-pattern report.

          • s3Bucket — (String)

            The S3 bucket name.

          • s3key — (String)

            The Amazon S3 key name.

        • antipatternReportStatus — (String)

          The status of the anti-pattern report generation.

          Possible values include:
          • "FAILED"
          • "IN_PROGRESS"
          • "SUCCESS"
        • antipatternReportStatusMessage — (String)

          A message about the status of the anti-pattern report generation.

        • applicationComponentStrategySummary — (Array<map>)

          A list of strategy summaries.

          • count — (Integer)

            The count of recommendations per strategy.

          • strategy — (String)

            The name of recommended strategy.

            Possible values include:
            • "Rehost"
            • "Retirement"
            • "Refactor"
            • "Replatform"
            • "Retain"
            • "Relocate"
            • "Repurchase"
        • dataCollectionStatus — (String)

          The status of assessment for the server.

          Possible values include:
          • "dataCollectionTaskToBeScheduled"
          • "dataCollectionTaskScheduled"
          • "dataCollectionTaskStarted"
          • "dataCollectionTaskStopped"
          • "dataCollectionTaskSuccess"
          • "dataCollectionTaskFailed"
          • "dataCollectionTaskPartialSuccess"
        • id — (String)

          The server ID.

        • lastAnalyzedTimestamp — (Date)

          The timestamp of when the server was assessed.

        • listAntipatternSeveritySummary — (Array<map>)

          A list of anti-pattern severity summaries.

          • count — (Integer)

            Contains the count of anti-patterns.

          • severity — (String)

            Contains the severity of anti-patterns.

            Possible values include:
            • "HIGH"
            • "MEDIUM"
            • "LOW"
        • name — (String)

          The name of the server.

        • recommendationSet — (map)

          A set of recommendations.

          • strategy — (String)

            The recommended strategy.

            Possible values include:
            • "Rehost"
            • "Retirement"
            • "Refactor"
            • "Replatform"
            • "Retain"
            • "Relocate"
            • "Repurchase"
          • targetDestination — (String)

            The recommended target destination.

            Possible values include:
            • "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"
          • transformationTool — (map)

            The target destination for the recommendation set.

            • description — (String)

              Description of the tool.

            • name — (String)

              Name of the tool.

              Possible values include:
              • "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"
            • tranformationToolInstallationLink — (String)

              URL for installing the tool.

        • serverType — (String)

          The type of server.

        • statusMessage — (String)

          A message about the status of data collection, which contains detailed descriptions of any error messages.

        • systemInfo — (map)

          System information about the server.

          • cpuArchitecture — (String)

            CPU architecture type for the server.

          • fileSystemType — (String)

            File system type for the server.

          • networkInfoList — (Array<map>)

            Networking information related to a server.

            • interfaceNamerequired — (String)

              Information about the name of the interface of the server for which the assessment was run.

            • ipAddressrequired — (String)

              Information about the IP address of the server for which the assessment was run.

            • macAddressrequired — (String)

              Information about the MAC address of the server for which the assessment was run.

            • netMaskrequired — (String)

              Information about the subnet mask of the server for which the assessment was run.

          • osInfo — (map)

            Operating system corresponding to a server.

            • type — (String)

              Information about the type of operating system.

              Possible values include:
              • "LINUX"
              • "WINDOWS"
            • version — (String)

              Information about the version of operating system.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putPortfolioPreferences(params = {}, callback) ⇒ AWS.Request

Saves the specified migration and modernization preferences.

Service Reference:

Examples:

Calling the putPortfolioPreferences operation

var params = {
  applicationPreferences: {
    managementPreference: {
      awsManagedResources: {
        targetDestination: [ /* required */
          None specified | AWS Elastic BeanStalk | AWS Fargate,
          /* more items */
        ]
      },
      noPreference: {
        targetDestination: [ /* required */
          None specified | AWS Elastic BeanStalk | AWS Fargate | Amazon Elastic Cloud Compute (EC2) | Amazon Elastic Container Service (ECS) | Amazon Elastic Kubernetes Service (EKS),
          /* more items */
        ]
      },
      selfManageResources: {
        targetDestination: [ /* required */
          None specified | Amazon Elastic Cloud Compute (EC2) | Amazon Elastic Container Service (ECS) | Amazon Elastic Kubernetes Service (EKS),
          /* more items */
        ]
      }
    }
  },
  databasePreferences: {
    databaseManagementPreference: AWS-managed | Self-manage | No preference,
    databaseMigrationPreference: {
      heterogeneous: {
        targetDatabaseEngine: [ /* required */
          None specified | Amazon Aurora | AWS PostgreSQL | MySQL | Microsoft SQL Server | Oracle Database | MariaDB | SAP | Db2 LUW | MongoDB,
          /* more items */
        ]
      },
      homogeneous: {
        targetDatabaseEngine: [
          None specified,
          /* more items */
        ]
      },
      noPreference: {
        targetDatabaseEngine: [ /* required */
          None specified | Amazon Aurora | AWS PostgreSQL | MySQL | Microsoft SQL Server | Oracle Database | MariaDB | SAP | Db2 LUW | MongoDB,
          /* more items */
        ]
      }
    }
  },
  prioritizeBusinessGoals: {
    businessGoals: {
      licenseCostReduction: 'NUMBER_VALUE',
      modernizeInfrastructureWithCloudNativeTechnologies: 'NUMBER_VALUE',
      reduceOperationalOverheadWithManagedServices: 'NUMBER_VALUE',
      speedOfMigration: 'NUMBER_VALUE'
    }
  }
};
migrationhubstrategy.putPortfolioPreferences(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationPreferences — (map)

      The transformation preferences for non-database applications.

      • managementPreference — (map)

        Application preferences that you specify to prefer managed environment.

        • awsManagedResources — (map)

          Indicates interest in solutions that are managed by AWS.

          • targetDestinationrequired — (Array<String>)

            The choice of application destination that you specify.

        • noPreference — (map)

          No specific preference.

          • targetDestinationrequired — (Array<String>)

            The choice of application destination that you specify.

        • selfManageResources — (map)

          Indicates interest in managing your own resources on AWS.

          • targetDestinationrequired — (Array<String>)

            Self-managed resources target destination.

    • databasePreferences — (map)

      The transformation preferences for database applications.

      • databaseManagementPreference — (String)

        Specifies whether you're interested in self-managed databases or databases managed by AWS.

        Possible values include:
        • "AWS-managed"
        • "Self-manage"
        • "No preference"
      • databaseMigrationPreference — (map)

        Specifies your preferred migration path.

        • heterogeneous — (map)

          Indicates whether you are interested in moving from one type of database to another. For example, from SQL Server to Amazon Aurora MySQL-Compatible Edition.

          • targetDatabaseEnginerequired — (Array<String>)

            The target database engine for heterogeneous database migration preference.

        • homogeneous — (map)

          Indicates whether you are interested in moving to the same type of database into AWS. For example, from SQL Server in your environment to SQL Server on AWS.

          • targetDatabaseEngine — (Array<String>)

            The target database engine for homogeneous database migration preferences.

        • noPreference — (map)

          Indicated that you do not prefer heterogeneous or homogeneous.

          • targetDatabaseEnginerequired — (Array<String>)

            The target database engine for database migration preference that you specify.

    • prioritizeBusinessGoals — (map)

      The rank of the business goals based on priority.

      • businessGoals — (map)

        Rank of business goals based on priority.

        • licenseCostReduction — (Integer)

          Business goal to reduce license costs.

        • modernizeInfrastructureWithCloudNativeTechnologies — (Integer)

          Business goal to modernize infrastructure by moving to cloud native technologies.

        • reduceOperationalOverheadWithManagedServices — (Integer)

          Business goal to reduce the operational overhead on the team by moving into managed services.

        • speedOfMigration — (Integer)

          Business goal to achieve migration at a fast pace.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startAssessment(params = {}, callback) ⇒ AWS.Request

Starts the assessment of an on-premises environment.

Service Reference:

Examples:

Calling the startAssessment operation

var params = {
  s3bucketForAnalysisData: 'STRING_VALUE',
  s3bucketForReportData: 'STRING_VALUE'
};
migrationhubstrategy.startAssessment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • s3bucketForAnalysisData — (String)

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

    • s3bucketForReportData — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • assessmentId — (String)

        The ID of the assessment.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startImportFileTask(params = {}, callback) ⇒ AWS.Request

Starts a file import.

Service Reference:

Examples:

Calling the startImportFileTask operation

var params = {
  S3Bucket: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  s3key: 'STRING_VALUE', /* required */
  dataSourceType: ApplicationDiscoveryService | MPA,
  groupId: [
    {
      name: ExternalId,
      value: 'STRING_VALUE'
    },
    /* more items */
  ],
  s3bucketForReportData: 'STRING_VALUE'
};
migrationhubstrategy.startImportFileTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • S3Bucket — (String)

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

    • dataSourceType — (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.

      Possible values include:
      • "ApplicationDiscoveryService"
      • "MPA"
    • groupId — (Array<map>)

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

      • name — (String)

        The key of the specific import group.

        Possible values include:
        • "ExternalId"
      • value — (String)

        The value of the specific import group.

    • name — (String)

      A descriptive name for the request.

    • s3bucketForReportData — (String)

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

    • s3key — (String)

      The Amazon S3 key name of the import file.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • id — (String)

        The ID for a specific import task. The ID is unique within an AWS account.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startRecommendationReportGeneration(params = {}, callback) ⇒ AWS.Request

Starts generating a recommendation report.

Examples:

Calling the startRecommendationReportGeneration operation

var params = {
  groupIdFilter: [
    {
      name: ExternalId,
      value: 'STRING_VALUE'
    },
    /* more items */
  ],
  outputFormat: Excel | Json
};
migrationhubstrategy.startRecommendationReportGeneration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • groupIdFilter — (Array<map>)

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

      • name — (String)

        The key of the specific import group.

        Possible values include:
        • "ExternalId"
      • value — (String)

        The value of the specific import group.

    • outputFormat — (String)

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

      Possible values include:
      • "Excel"
      • "Json"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • id — (String)

        The ID of the recommendation report generation task.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopAssessment(params = {}, callback) ⇒ AWS.Request

Stops the assessment of an on-premises environment.

Service Reference:

Examples:

Calling the stopAssessment operation

var params = {
  assessmentId: 'STRING_VALUE' /* required */
};
migrationhubstrategy.stopAssessment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateApplicationComponentConfig(params = {}, callback) ⇒ AWS.Request

Updates the configuration of an application component.

Examples:

Calling the updateApplicationComponentConfig operation

var params = {
  applicationComponentId: 'STRING_VALUE', /* required */
  inclusionStatus: excludeFromAssessment | includeInAssessment,
  secretsManagerKey: 'STRING_VALUE',
  sourceCodeList: [
    {
      location: 'STRING_VALUE',
      sourceVersion: 'STRING_VALUE',
      versionControl: GITHUB | GITHUB_ENTERPRISE
    },
    /* more items */
  ],
  strategyOption: {
    isPreferred: true || false,
    strategy: Rehost | Retirement | Refactor | Replatform | Retain | Relocate | Repurchase,
    targetDestination: 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,
    toolName: 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
  }
};
migrationhubstrategy.updateApplicationComponentConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationComponentId — (String)

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

    • inclusionStatus — (String)

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

      Possible values include:
      • "excludeFromAssessment"
      • "includeInAssessment"
    • secretsManagerKey — (String)

      Database credentials.

    • sourceCodeList — (Array<map>)

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

      • location — (String)

        The repository name for the source code.

      • sourceVersion — (String)

        The branch of the source code.

      • versionControl — (String)

        The type of repository to use for the source code.

        Possible values include:
        • "GITHUB"
        • "GITHUB_ENTERPRISE"
    • strategyOption — (map)

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

      • isPreferred — (Boolean)

        Indicates if a specific strategy is preferred for the application component.

      • strategy — (String)

        Type of transformation. For example, Rehost, Replatform, and so on.

        Possible values include:
        • "Rehost"
        • "Retirement"
        • "Refactor"
        • "Replatform"
        • "Retain"
        • "Relocate"
        • "Repurchase"
      • targetDestination — (String)

        Destination information about where the application component can migrate to. For example, EC2, ECS, and so on.

        Possible values include:
        • "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"
      • toolName — (String)

        The name of the tool that can be used to transform an application component using this strategy.

        Possible values include:
        • "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"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateServerConfig(params = {}, callback) ⇒ AWS.Request

Updates the configuration of the specified server.

Service Reference:

Examples:

Calling the updateServerConfig operation

var params = {
  serverId: 'STRING_VALUE', /* required */
  strategyOption: {
    isPreferred: true || false,
    strategy: Rehost | Retirement | Refactor | Replatform | Retain | Relocate | Repurchase,
    targetDestination: 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,
    toolName: 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
  }
};
migrationhubstrategy.updateServerConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • serverId — (String)

      The ID of the server.

    • strategyOption — (map)

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

      • isPreferred — (Boolean)

        Indicates if a specific strategy is preferred for the application component.

      • strategy — (String)

        Type of transformation. For example, Rehost, Replatform, and so on.

        Possible values include:
        • "Rehost"
        • "Retirement"
        • "Refactor"
        • "Replatform"
        • "Retain"
        • "Relocate"
        • "Repurchase"
      • targetDestination — (String)

        Destination information about where the application component can migrate to. For example, EC2, ECS, and so on.

        Possible values include:
        • "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"
      • toolName — (String)

        The name of the tool that can be used to transform an application component using this strategy.

        Possible values include:
        • "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"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.