Class: AWS.MigrationHubStrategy

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"
          • "Babelfish for Aurora PostgreSQL"
        • 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"
        • "potential"

Returns:

• (AWS.Request) —

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

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: {}) —
  • id — (String)

    The assessmentid returned by StartAssessment.

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:

    • assessmentTargets — (Array<map>)

      List of criteria for assessment.

      • condition — required — (String)

        Condition of an assessment.

        Possible values include:
        • "EQUALS"
        • "NOT_EQUALS"
        • "CONTAINS"
        • "NOT_CONTAINS"
      • name — required — (String)

        Name of an assessment.

      • values — required — (Array<String>)

        Values of an assessment.

    • 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"
      • statusMessage — (String)

        The status message of the assessment.

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

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.

var params = {
};
migrationhubstrategy.getLatestAssessmentId(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:

    • id — (String)

      The latest ID for the specific assessment task.

Returns:

• (AWS.Request) —

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

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:

    • applicationMode — (String)

      The classification for application component types.

      Possible values include:
      • "ALL"
      • "KNOWN"
      • "UNKNOWN"
    • 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.

          • targetDestination — required — (Array<String>)

            The choice of application destination that you specify.

        • noPreference — (map)

          No specific preference.

          • targetDestination — required — (Array<String>)

            The choice of application destination that you specify.

        • selfManageResources — (map)

          Indicates interest in managing your own resources on AWS.

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

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

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

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"
      • listApplicationComponentStatusSummary — (Array<map>)

        List of status summaries of the analyzed application components.

        • count — (Integer)

          The number of application components successfully analyzed, partially successful or failed analysis.

        • srcCodeOrDbAnalysisStatus — (String)

          The status of database analysis.

          Possible values include:
          • "ANALYSIS_TO_BE_SCHEDULED"
          • "ANALYSIS_STARTED"
          • "ANALYSIS_SUCCESS"
          • "ANALYSIS_FAILED"
          • "ANALYSIS_PARTIAL_SUCCESS"
          • "UNCONFIGURED"
          • "CONFIGURED"
      • 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"
          • "Tomcat"
          • "JBoss"
          • "Spring"
          • "Mongo DB"
          • "DB2"
          • "Maria DB"
          • "MySQL"
          • "Sybase"
          • "PostgreSQLServer"
          • "Cassandra"
          • "IBM WebSphere"
          • "Oracle WebLogic"
          • "Visual Basic"
          • "Unknown"
          • "DotnetCore"
          • "Dotnet"
        • count — (Integer)

          Contains the count of application type.

      • listServerStatusSummary — (Array<map>)

        List of status summaries of the analyzed servers.

        • count — (Integer)

          The number of servers successfully analyzed, partially successful or failed analysis.

        • runTimeAssessmentStatus — (String)

          The status of the run time.

          Possible values include:
          • "dataCollectionTaskToBeScheduled"
          • "dataCollectionTaskScheduled"
          • "dataCollectionTaskStarted"
          • "dataCollectionTaskStopped"
          • "dataCollectionTaskSuccess"
          • "dataCollectionTaskFailed"
          • "dataCollectionTaskPartialSuccess"
      • 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.

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:

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

    The recommendation report generation task id returned by StartRecommendationReportGeneration.

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.

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"
          • "Babelfish for Aurora PostgreSQL"
        • 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.

      • serverError — (map)

        The error in server analysis.

        • serverErrorCategory — (String)

          The error category of server analysis.

          Possible values include:
          • "CONNECTIVITY_ERROR"
          • "CREDENTIAL_ERROR"
          • "PERMISSION_ERROR"
          • "ARCHITECTURE_ERROR"
          • "OTHER_ERROR"
      • 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.

          • interfaceName — required — (String)

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

          • ipAddress — required — (String)

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

          • macAddress — required — (String)

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

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

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"
          • "Babelfish for Aurora PostgreSQL"
        • 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"
        • "potential"

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sort: ASC | DESC
};
migrationhubstrategy.listAnalyzableServers(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.

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

    • analyzableServers — (Array<map>)

      The list of analyzable servers with summary information about each server.

      • hostname — (String)

        The host name of the analyzable server.

      • ipAddress — (String)

        The ip address of the analyzable server.

      • source — (String)

        The data source of the analyzable server.

      • vmId — (String)

        The virtual machine id of the analyzable server.

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

var params = {
  applicationComponentCriteria: NOT_DEFINED | APP_NAME | SERVER_ID | APP_TYPE | STRATEGY | DESTINATION | ANALYSIS_STATUS | ERROR_CATEGORY,
  filterValue: 'STRING_VALUE',
  groupIdFilter: [
    {
      name: ExternalId | ExternalSourceType,
      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"
    • "ANALYSIS_STATUS"
    • "ERROR_CATEGORY"
  • 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"
      • "ExternalSourceType"
    • 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"
        • "ANALYSIS_PARTIAL_SUCCESS"
        • "UNCONFIGURED"
        • "CONFIGURED"
      • 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"
        • "Tomcat"
        • "JBoss"
        • "Spring"
        • "Mongo DB"
        • "DB2"
        • "Maria DB"
        • "MySQL"
        • "Sybase"
        • "PostgreSQLServer"
        • "Cassandra"
        • "IBM WebSphere"
        • "Oracle WebLogic"
        • "Visual Basic"
        • "Unknown"
        • "DotnetCore"
        • "Dotnet"
      • appUnitError — (map)

        The error in the analysis of the source code or database.

        • appUnitErrorCategory — (String)

          The category of the error.

          Possible values include:
          • "CREDENTIAL_ERROR"
          • "CONNECTIVITY_ERROR"
          • "PERMISSION_ERROR"
          • "UNSUPPORTED_ERROR"
          • "OTHER_ERROR"
      • 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"
          • "Babelfish for Aurora PostgreSQL"
        • 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"
      • resultList — (Array<map>)

        A list of the analysis results.

        • analysisStatus — (map)

          The error in server analysis.

          • runtimeAnalysisStatus — (String)

            The status of the analysis.

            Possible values include:
            • "ANALYSIS_TO_BE_SCHEDULED"
            • "ANALYSIS_STARTED"
            • "ANALYSIS_SUCCESS"
            • "ANALYSIS_FAILED"
          • srcCodeOrDbAnalysisStatus — (String)

            The status of the source code or database analysis.

            Possible values include:
            • "ANALYSIS_TO_BE_SCHEDULED"
            • "ANALYSIS_STARTED"
            • "ANALYSIS_SUCCESS"
            • "ANALYSIS_FAILED"
            • "ANALYSIS_PARTIAL_SUCCESS"
            • "UNCONFIGURED"
            • "CONFIGURED"
        • analysisType — (String)

          The error in server analysis.

          Possible values include:
          • "SOURCE_CODE_ANALYSIS"
          • "DATABASE_ANALYSIS"
          • "RUNTIME_ANALYSIS"
          • "BINARY_ANALYSIS"
        • antipatternReportResultList — (Array<map>)

          The error in server analysis.

          • analyzerName — (map)

            The analyzer name.

            • binaryAnalyzerName — (String)

              The binary analyzer names.

              Possible values include:
              • "DLL_ANALYZER"
              • "BYTECODE_ANALYZER"
            • runTimeAnalyzerName — (String)

              The assessment analyzer names.

              Possible values include:
              • "A2C_ANALYZER"
              • "REHOST_ANALYZER"
              • "EMP_PA_ANALYZER"
              • "DATABASE_ANALYZER"
              • "SCT_ANALYZER"
            • sourceCodeAnalyzerName — (String)

              The source code analyzer names.

              Possible values include:
              • "CSHARP_ANALYZER"
              • "JAVA_ANALYZER"
              • "BYTECODE_ANALYZER"
              • "PORTING_ASSISTANT"
          • antiPatternReportS3Object — (map)

            Contains the S3 bucket name and the Amazon S3 key name.

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

        • statusMessage — (String)

          The error in server analysis.

      • runtimeStatus — (String)

        The status of the application unit.

        Possible values include:
        • "ANALYSIS_TO_BE_SCHEDULED"
        • "ANALYSIS_STARTED"
        • "ANALYSIS_SUCCESS"
        • "ANALYSIS_FAILED"
      • runtimeStatusMessage — (String)

        The status message for the application unit.

      • sourceCodeRepositories — (Array<map>)

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

        • branch — (String)

          The branch of the source code.

        • projectName — (String)

          The name of the project.

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

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.

      • configurationSummary — (map)

        Summary of the collector configuration.

        • ipAddressBasedRemoteInfoList — (Array<map>)

          IP address based configurations.

          • authType — (String)

            The type of authorization.

            Possible values include:
            • "NTLM"
            • "SSH"
            • "CERT"
          • ipAddressConfigurationTimeStamp — (String)

            The time stamp of the configuration.

          • osType — (String)

            The type of the operating system.

            Possible values include:
            • "LINUX"
            • "WINDOWS"
        • pipelineInfoList — (Array<map>)

          The list of pipeline info configurations.

          • pipelineConfigurationTimeStamp — (String)

            The time when the pipeline info was configured.

          • pipelineType — (String)

            The type of pipeline.

            Possible values include:
            • "AZURE_DEVOPS"
        • remoteSourceCodeAnalysisServerInfo — (map)

          Info about the remote server source code configuration.

          • remoteSourceCodeAnalysisServerConfigurationTimestamp — (String)

            The time when the remote source code server was configured.

        • vcenterBasedRemoteInfoList — (Array<map>)

          The list of vCenter configurations.

          • osType — (String)

            The type of the operating system.

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

            The time when the remote server based on vCenter was last configured.

        • versionControlInfoList — (Array<map>)

          The list of the version control configurations.

          • versionControlConfigurationTimeStamp — (String)

            The time when the version control system was last configured.

          • versionControlType — (String)

            The type of version control.

            Possible values include:
            • "GITHUB"
            • "GITHUB_ENTERPRISE"
            • "AZURE_DEVOPS_GIT"
      • 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.

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.

var params = {
  filterValue: 'STRING_VALUE',
  groupIdFilter: [
    {
      name: ExternalId | ExternalSourceType,
      value: 'STRING_VALUE'
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  serverCriteria: NOT_DEFINED | OS_NAME | STRATEGY | DESTINATION | SERVER_ID | ANALYSIS_STATUS | ERROR_CATEGORY,
  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"
      • "ExternalSourceType"
    • 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"
    • "ANALYSIS_STATUS"
    • "ERROR_CATEGORY"
  • 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"
          • "Babelfish for Aurora PostgreSQL"
        • 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.

      • serverError — (map)

        The error in server analysis.

        • serverErrorCategory — (String)

          The error category of server analysis.

          Possible values include:
          • "CONNECTIVITY_ERROR"
          • "CREDENTIAL_ERROR"
          • "PERMISSION_ERROR"
          • "ARCHITECTURE_ERROR"
          • "OTHER_ERROR"
      • 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.

          • interfaceName — required — (String)

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

          • ipAddress — required — (String)

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

          • macAddress — required — (String)

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

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

var params = {
  applicationMode: ALL | KNOWN | UNKNOWN,
  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: {}) —
  • applicationMode — (String)

    The classification for application component types.

    Possible values include:
    • "ALL"
    • "KNOWN"
    • "UNKNOWN"
  • 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.

        • targetDestination — required — (Array<String>)

          The choice of application destination that you specify.

      • noPreference — (map)

        No specific preference.

        • targetDestination — required — (Array<String>)

          The choice of application destination that you specify.

      • selfManageResources — (map)

        Indicates interest in managing your own resources on AWS.

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

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

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

var params = {
  assessmentDataSourceType: StrategyRecommendationsApplicationDataCollector | ManualImport | ApplicationDiscoveryService,
  assessmentTargets: [
    {
      condition: EQUALS | NOT_EQUALS | CONTAINS | NOT_CONTAINS, /* required */
      name: 'STRING_VALUE', /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  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: {}) —
  • assessmentDataSourceType — (String)

    The data source type of an assessment to be started.

    Possible values include:
    • "StrategyRecommendationsApplicationDataCollector"
    • "ManualImport"
    • "ApplicationDiscoveryService"
  • assessmentTargets — (Array<map>)

    List of criteria for assessment.

    • condition — required — (String)

      Condition of an assessment.

      Possible values include:
      • "EQUALS"
      • "NOT_EQUALS"
      • "CONTAINS"
      • "NOT_CONTAINS"
    • name — required — (String)

      Name of an assessment.

    • values — required — (Array<String>)

      Values of an assessment.

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

var params = {
  S3Bucket: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  s3key: 'STRING_VALUE', /* required */
  dataSourceType: ApplicationDiscoveryService | MPA | Import | StrategyRecommendationsApplicationDataCollector,
  groupId: [
    {
      name: ExternalId | ExternalSourceType,
      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"
    • "Import"
    • "StrategyRecommendationsApplicationDataCollector"
  • 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"
      • "ExternalSourceType"
    • 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.

var params = {
  groupIdFilter: [
    {
      name: ExternalId | ExternalSourceType,
      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"
      • "ExternalSourceType"
    • 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.

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: {}) —
  • assessmentId — (String)

    The assessmentId returned by StartAssessment.

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.

var params = {
  applicationComponentId: 'STRING_VALUE', /* required */
  appType: DotNetFramework | Java | SQLServer | IIS | Oracle | Other | Tomcat | JBoss | Spring | Mongo DB | DB2 | Maria DB | MySQL | Sybase | PostgreSQLServer | Cassandra | IBM WebSphere | Oracle WebLogic | Visual Basic | Unknown | DotnetCore | Dotnet,
  configureOnly: true || false,
  inclusionStatus: excludeFromAssessment | includeInAssessment,
  secretsManagerKey: 'STRING_VALUE',
  sourceCodeList: [
    {
      location: 'STRING_VALUE',
      projectName: 'STRING_VALUE',
      sourceVersion: 'STRING_VALUE',
      versionControl: GITHUB | GITHUB_ENTERPRISE | AZURE_DEVOPS_GIT
    },
    /* 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 | Babelfish for Aurora PostgreSQL,
    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: {}) —
  • appType — (String)

    The type of known component.

    Possible values include:
    • "DotNetFramework"
    • "Java"
    • "SQLServer"
    • "IIS"
    • "Oracle"
    • "Other"
    • "Tomcat"
    • "JBoss"
    • "Spring"
    • "Mongo DB"
    • "DB2"
    • "Maria DB"
    • "MySQL"
    • "Sybase"
    • "PostgreSQLServer"
    • "Cassandra"
    • "IBM WebSphere"
    • "Oracle WebLogic"
    • "Visual Basic"
    • "Unknown"
    • "DotnetCore"
    • "Dotnet"
  • applicationComponentId — (String)

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

  • configureOnly — (Boolean)

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

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

    • projectName — (String)

      The name of the project.

    • 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"
      • "AZURE_DEVOPS_GIT"
  • 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"
      • "Babelfish for Aurora PostgreSQL"
    • 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.

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 | Babelfish for Aurora PostgreSQL,
    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"
      • "Babelfish for Aurora PostgreSQL"
    • 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.