SDK for PHP 3.x

Migration Hub Strategy Recommendations 2020-02-19

Client: Aws\MigrationHubStrategyRecommendations\MigrationHubStrategyRecommendationsClient
Service ID: migrationhubstrategy
Version: 2020-02-19

This page describes the parameters and results for the operations of the Migration Hub Strategy Recommendations (2020-02-19), and shows how to use the Aws\MigrationHubStrategyRecommendations\MigrationHubStrategyRecommendationsClient object to call the described operations. This documentation is specific to the 2020-02-19 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

GetApplicationComponentDetails ( array $params = [] )
Retrieves details about an application component.
GetApplicationComponentStrategies ( array $params = [] )
Retrieves a list of all the recommended strategies and tools for an application component running on a server.
GetAssessment ( array $params = [] )
Retrieves the status of an on-going assessment.
GetImportFileTask ( array $params = [] )
Retrieves the details about a specific import task.
GetLatestAssessmentId ( array $params = [] )
Retrieve the latest ID of a specific assessment task.
GetPortfolioPreferences ( array $params = [] )
Retrieves your migration and modernization preferences.
GetPortfolioSummary ( array $params = [] )
Retrieves overall summary including the number of servers to rehost and the overall number of anti-patterns.
GetRecommendationReportDetails ( array $params = [] )
Retrieves detailed information about the specified recommendation report.
GetServerDetails ( array $params = [] )
Retrieves detailed information about a specified server.
GetServerStrategies ( array $params = [] )
Retrieves recommended strategies and tools for the specified server.
ListAnalyzableServers ( array $params = [] )
Retrieves a list of all the servers fetched from customer vCenter using Strategy Recommendation Collector.
ListApplicationComponents ( array $params = [] )
Retrieves a list of all the application components (processes).
ListCollectors ( array $params = [] )
Retrieves a list of all the installed collectors.
ListImportFileTask ( array $params = [] )
Retrieves a list of all the imports performed.
ListServers ( array $params = [] )
Returns a list of all the servers.
PutPortfolioPreferences ( array $params = [] )
Saves the specified migration and modernization preferences.
StartAssessment ( array $params = [] )
Starts the assessment of an on-premises environment.
StartImportFileTask ( array $params = [] )
Starts a file import.
StartRecommendationReportGeneration ( array $params = [] )
Starts generating a recommendation report.
StopAssessment ( array $params = [] )
Stops the assessment of an on-premises environment.
UpdateApplicationComponentConfig ( array $params = [] )
Updates the configuration of an application component.
UpdateServerConfig ( array $params = [] )
Updates the configuration of the specified server.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

GetServerDetails
ListAnalyzableServers
ListApplicationComponents
ListCollectors
ListImportFileTask
ListServers

Operations

GetApplicationComponentDetails 

$result = $client->getApplicationComponentDetails([/* ... */]);
$promise = $client->getApplicationComponentDetailsAsync([/* ... */]);

Retrieves details about an application component.

Parameter Syntax

$result = $client->getApplicationComponentDetails([
    'applicationComponentId' => '<string>', // REQUIRED
]);

Parameter Details

Members
applicationComponentId
Required: Yes
Type: string

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

Result Syntax

[
    'applicationComponentDetail' => [
        'analysisStatus' => 'ANALYSIS_TO_BE_SCHEDULED|ANALYSIS_STARTED|ANALYSIS_SUCCESS|ANALYSIS_FAILED|ANALYSIS_PARTIAL_SUCCESS|UNCONFIGURED|CONFIGURED',
        'antipatternReportS3Object' => [
            's3Bucket' => '<string>',
            's3key' => '<string>',
        ],
        'antipatternReportStatus' => 'FAILED|IN_PROGRESS|SUCCESS',
        'antipatternReportStatusMessage' => '<string>',
        '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',
        'appUnitError' => [
            'appUnitErrorCategory' => 'CREDENTIAL_ERROR|CONNECTIVITY_ERROR|PERMISSION_ERROR|UNSUPPORTED_ERROR|OTHER_ERROR',
        ],
        'associatedServerId' => '<string>',
        'databaseConfigDetail' => [
            'secretName' => '<string>',
        ],
        'id' => '<string>',
        'inclusionStatus' => 'excludeFromAssessment|includeInAssessment',
        'lastAnalyzedTimestamp' => <DateTime>,
        'listAntipatternSeveritySummary' => [
            [
                'count' => <integer>,
                'severity' => 'HIGH|MEDIUM|LOW',
            ],
            // ...
        ],
        'moreServerAssociationExists' => true || false,
        'name' => '<string>',
        'osDriver' => '<string>',
        'osVersion' => '<string>',
        'recommendationSet' => [
            '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',
            'transformationTool' => [
                'description' => '<string>',
                'name' => '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>',
            ],
        ],
        'resourceSubType' => 'Database|Process|DatabaseProcess',
        'resultList' => [
            [
                'analysisStatus' => [
                    'runtimeAnalysisStatus' => 'ANALYSIS_TO_BE_SCHEDULED|ANALYSIS_STARTED|ANALYSIS_SUCCESS|ANALYSIS_FAILED',
                    'srcCodeOrDbAnalysisStatus' => 'ANALYSIS_TO_BE_SCHEDULED|ANALYSIS_STARTED|ANALYSIS_SUCCESS|ANALYSIS_FAILED|ANALYSIS_PARTIAL_SUCCESS|UNCONFIGURED|CONFIGURED',
                ],
                'analysisType' => 'SOURCE_CODE_ANALYSIS|DATABASE_ANALYSIS|RUNTIME_ANALYSIS|BINARY_ANALYSIS',
                'antipatternReportResultList' => [
                    [
                        'analyzerName' => [
                            'binaryAnalyzerName' => 'DLL_ANALYZER|BYTECODE_ANALYZER',
                            'runTimeAnalyzerName' => 'A2C_ANALYZER|REHOST_ANALYZER|EMP_PA_ANALYZER|DATABASE_ANALYZER|SCT_ANALYZER',
                            'sourceCodeAnalyzerName' => 'CSHARP_ANALYZER|JAVA_ANALYZER|BYTECODE_ANALYZER|PORTING_ASSISTANT',
                        ],
                        'antiPatternReportS3Object' => [
                            's3Bucket' => '<string>',
                            's3key' => '<string>',
                        ],
                        'antipatternReportStatus' => 'FAILED|IN_PROGRESS|SUCCESS',
                        'antipatternReportStatusMessage' => '<string>',
                    ],
                    // ...
                ],
                'statusMessage' => '<string>',
            ],
            // ...
        ],
        'runtimeStatus' => 'ANALYSIS_TO_BE_SCHEDULED|ANALYSIS_STARTED|ANALYSIS_SUCCESS|ANALYSIS_FAILED',
        'runtimeStatusMessage' => '<string>',
        'sourceCodeRepositories' => [
            [
                'branch' => '<string>',
                'projectName' => '<string>',
                'repository' => '<string>',
                'versionControlType' => '<string>',
            ],
            // ...
        ],
        'statusMessage' => '<string>',
    ],
    'associatedApplications' => [
        [
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'associatedServerIds' => ['<string>', ...],
    'moreApplicationResource' => true || false,
]

Result Details

Members
applicationComponentDetail
Type: ApplicationComponentDetail structure

Detailed information about an application component.

associatedApplications
Type: Array of AssociatedApplication structures

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

associatedServerIds
Type: Array of strings

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

moreApplicationResource
Type: boolean

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

Errors

ResourceNotFoundException:

The specified ID in the request is not found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The server experienced an internal error. Try again.

GetApplicationComponentStrategies 

$result = $client->getApplicationComponentStrategies([/* ... */]);
$promise = $client->getApplicationComponentStrategiesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getApplicationComponentStrategies([
    'applicationComponentId' => '<string>', // REQUIRED
]);

Parameter Details

Members
applicationComponentId
Required: Yes
Type: string

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

Result Syntax

[
    'applicationComponentStrategies' => [
        [
            'isPreferred' => true || false,
            'recommendation' => [
                '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',
                'transformationTool' => [
                    'description' => '<string>',
                    'name' => '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>',
                ],
            ],
            'status' => 'recommended|viableOption|notRecommended|potential',
        ],
        // ...
    ],
]

Result Details

Members
applicationComponentStrategies
Type: Array of ApplicationComponentStrategy structures

A list of application component strategy recommendations.

Errors

ResourceNotFoundException:

The specified ID in the request is not found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The server experienced an internal error. Try again.

GetAssessment 

$result = $client->getAssessment([/* ... */]);
$promise = $client->getAssessmentAsync([/* ... */]);

Retrieves the status of an on-going assessment.

Parameter Syntax

$result = $client->getAssessment([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The assessmentid returned by StartAssessment.

Result Syntax

[
    'assessmentTargets' => [
        [
            'condition' => 'EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS',
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'dataCollectionDetails' => [
        'completionTime' => <DateTime>,
        'failed' => <integer>,
        'inProgress' => <integer>,
        'servers' => <integer>,
        'startTime' => <DateTime>,
        'status' => 'IN_PROGRESS|COMPLETE|FAILED|STOPPED',
        'statusMessage' => '<string>',
        'success' => <integer>,
    ],
    'id' => '<string>',
]

Result Details

Members
assessmentTargets
Type: Array of AssessmentTarget structures

List of criteria for assessment.

dataCollectionDetails
Type: DataCollectionDetails structure

Detailed information about the assessment.

id
Type: string

The ID for the specific assessment task.

Errors

ResourceNotFoundException:

The specified ID in the request is not found.

AccessDeniedException:

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The server experienced an internal error. Try again.

GetImportFileTask 

$result = $client->getImportFileTask([/* ... */]);
$promise = $client->getImportFileTaskAsync([/* ... */]);

Retrieves the details about a specific import task.

Parameter Syntax

$result = $client->getImportFileTask([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

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

Result Syntax

[
    'completionTime' => <DateTime>,
    'id' => '<string>',
    'importName' => '<string>',
    'inputS3Bucket' => '<string>',
    'inputS3Key' => '<string>',
    'numberOfRecordsFailed' => <integer>,
    'numberOfRecordsSuccess' => <integer>,
    'startTime' => <DateTime>,
    'status' => 'ImportInProgress|ImportFailed|ImportPartialSuccess|ImportSuccess|DeleteInProgress|DeleteFailed|DeletePartialSuccess|DeleteSuccess',
    'statusReportS3Bucket' => '<string>',
    'statusReportS3Key' => '<string>',
]

Result Details

Members
completionTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the import task completed.

id
Type: string

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

importName
Type: string

The name of the import task given in StartImportFileTask.

inputS3Bucket
Type: string

The S3 bucket where import file is located.

inputS3Key
Type: string

The Amazon S3 key name of the import file.

numberOfRecordsFailed
Type: int

The number of records that failed to be imported.

numberOfRecordsSuccess
Type: int

The number of records successfully imported.

startTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Start time of the import task.

status
Type: string

Status of import file task.

statusReportS3Bucket
Type: string

The S3 bucket name for status report of import task.

statusReportS3Key
Type: 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.

Errors

ResourceNotFoundException:

The specified ID in the request is not found.

AccessDeniedException:

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request body isn't valid.

InternalServerException:

The server experienced an internal error. Try again.

GetLatestAssessmentId 

$result = $client->getLatestAssessmentId([/* ... */]);
$promise = $client->getLatestAssessmentIdAsync([/* ... */]);

Retrieve the latest ID of a specific assessment task.

Parameter Syntax

$result = $client->getLatestAssessmentId([
]);

Parameter Details

Members

Result Syntax

[
    'id' => '<string>',
]

Result Details

Members
id
Type: string

The latest ID for the specific assessment task.

Errors

DependencyException:

Dependency encountered an error.

AccessDeniedException:

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

ValidationException:

The request body isn't valid.

InternalServerException:

The server experienced an internal error. Try again.

GetPortfolioPreferences 

$result = $client->getPortfolioPreferences([/* ... */]);
$promise = $client->getPortfolioPreferencesAsync([/* ... */]);

Retrieves your migration and modernization preferences.

Parameter Syntax

$result = $client->getPortfolioPreferences([
]);

Parameter Details

Members

Result Syntax

[
    'applicationMode' => 'ALL|KNOWN|UNKNOWN',
    'applicationPreferences' => [
        'managementPreference' => [
            'awsManagedResources' => [
                'targetDestination' => ['<string>', ...],
            ],
            'noPreference' => [
                'targetDestination' => ['<string>', ...],
            ],
            'selfManageResources' => [
                'targetDestination' => ['<string>', ...],
            ],
        ],
    ],
    'databasePreferences' => [
        'databaseManagementPreference' => 'AWS-managed|Self-manage|No preference',
        'databaseMigrationPreference' => [
            'heterogeneous' => [
                'targetDatabaseEngine' => ['<string>', ...],
            ],
            'homogeneous' => [
                'targetDatabaseEngine' => ['<string>', ...],
            ],
            'noPreference' => [
                'targetDatabaseEngine' => ['<string>', ...],
            ],
        ],
    ],
    'prioritizeBusinessGoals' => [
        'businessGoals' => [
            'licenseCostReduction' => <integer>,
            'modernizeInfrastructureWithCloudNativeTechnologies' => <integer>,
            'reduceOperationalOverheadWithManagedServices' => <integer>,
            'speedOfMigration' => <integer>,
        ],
    ],
]

Result Details

Members
applicationMode
Type: string

The classification for application component types.

applicationPreferences
Type: ApplicationPreferences structure

The transformation preferences for non-database applications.

databasePreferences
Type: DatabasePreferences structure

The transformation preferences for database applications.

prioritizeBusinessGoals
Type: PrioritizeBusinessGoals structure

The rank of business goals based on priority.

Errors

ResourceNotFoundException:

The specified ID in the request is not found.

AccessDeniedException:

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The server experienced an internal error. Try again.

GetPortfolioSummary 

$result = $client->getPortfolioSummary([/* ... */]);
$promise = $client->getPortfolioSummaryAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getPortfolioSummary([
]);

Parameter Details

Members

Result Syntax

[
    'assessmentSummary' => [
        'antipatternReportS3Object' => [
            's3Bucket' => '<string>',
            's3key' => '<string>',
        ],
        'antipatternReportStatus' => 'FAILED|IN_PROGRESS|SUCCESS',
        'antipatternReportStatusMessage' => '<string>',
        'lastAnalyzedTimestamp' => <DateTime>,
        'listAntipatternSeveritySummary' => [
            [
                'count' => <integer>,
                'severity' => 'HIGH|MEDIUM|LOW',
            ],
            // ...
        ],
        'listApplicationComponentStatusSummary' => [
            [
                'count' => <integer>,
                'srcCodeOrDbAnalysisStatus' => 'ANALYSIS_TO_BE_SCHEDULED|ANALYSIS_STARTED|ANALYSIS_SUCCESS|ANALYSIS_FAILED|ANALYSIS_PARTIAL_SUCCESS|UNCONFIGURED|CONFIGURED',
            ],
            // ...
        ],
        'listApplicationComponentStrategySummary' => [
            [
                'count' => <integer>,
                'strategy' => 'Rehost|Retirement|Refactor|Replatform|Retain|Relocate|Repurchase',
            ],
            // ...
        ],
        'listApplicationComponentSummary' => [
            [
                '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',
                'count' => <integer>,
            ],
            // ...
        ],
        'listServerStatusSummary' => [
            [
                'count' => <integer>,
                'runTimeAssessmentStatus' => 'dataCollectionTaskToBeScheduled|dataCollectionTaskScheduled|dataCollectionTaskStarted|dataCollectionTaskStopped|dataCollectionTaskSuccess|dataCollectionTaskFailed|dataCollectionTaskPartialSuccess',
            ],
            // ...
        ],
        'listServerStrategySummary' => [
            [
                'count' => <integer>,
                'strategy' => 'Rehost|Retirement|Refactor|Replatform|Retain|Relocate|Repurchase',
            ],
            // ...
        ],
        'listServerSummary' => [
            [
                'ServerOsType' => 'WindowsServer|AmazonLinux|EndOfSupportWindowsServer|Redhat|Other',
                'count' => <integer>,
            ],
            // ...
        ],
    ],
]

Result Details

Members
assessmentSummary
Type: AssessmentSummary structure

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

Errors

AccessDeniedException:

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The server experienced an internal error. Try again.

GetRecommendationReportDetails 

$result = $client->getRecommendationReportDetails([/* ... */]);
$promise = $client->getRecommendationReportDetailsAsync([/* ... */]);

Retrieves detailed information about the specified recommendation report.

Parameter Syntax

$result = $client->getRecommendationReportDetails([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The recommendation report generation task id returned by StartRecommendationReportGeneration.

Result Syntax

[
    'id' => '<string>',
    'recommendationReportDetails' => [
        'completionTime' => <DateTime>,
        's3Bucket' => '<string>',
        's3Keys' => ['<string>', ...],
        'startTime' => <DateTime>,
        'status' => 'FAILED|IN_PROGRESS|SUCCESS',
        'statusMessage' => '<string>',
    ],
]

Result Details

Members
id
Type: string

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

recommendationReportDetails
Type: RecommendationReportDetails structure

Detailed information about the recommendation report.

Errors

ResourceNotFoundException:

The specified ID in the request is not found.

AccessDeniedException:

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request body isn't valid.

InternalServerException:

The server experienced an internal error. Try again.

GetServerDetails 

$result = $client->getServerDetails([/* ... */]);
$promise = $client->getServerDetailsAsync([/* ... */]);

Retrieves detailed information about a specified server.

Parameter Syntax

$result = $client->getServerDetails([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'serverId' => '<string>', // REQUIRED
]);

Parameter Details

Members
maxResults
Type: int

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

nextToken
Type: 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
Required: Yes
Type: string

The ID of the server.

Result Syntax

[
    'associatedApplications' => [
        [
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'serverDetail' => [
        'antipatternReportS3Object' => [
            's3Bucket' => '<string>',
            's3key' => '<string>',
        ],
        'antipatternReportStatus' => 'FAILED|IN_PROGRESS|SUCCESS',
        'antipatternReportStatusMessage' => '<string>',
        'applicationComponentStrategySummary' => [
            [
                'count' => <integer>,
                'strategy' => 'Rehost|Retirement|Refactor|Replatform|Retain|Relocate|Repurchase',
            ],
            // ...
        ],
        'dataCollectionStatus' => 'dataCollectionTaskToBeScheduled|dataCollectionTaskScheduled|dataCollectionTaskStarted|dataCollectionTaskStopped|dataCollectionTaskSuccess|dataCollectionTaskFailed|dataCollectionTaskPartialSuccess',
        'id' => '<string>',
        'lastAnalyzedTimestamp' => <DateTime>,
        'listAntipatternSeveritySummary' => [
            [
                'count' => <integer>,
                'severity' => 'HIGH|MEDIUM|LOW',
            ],
            // ...
        ],
        'name' => '<string>',
        'recommendationSet' => [
            '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',
            'transformationTool' => [
                'description' => '<string>',
                'name' => '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>',
            ],
        ],
        'serverError' => [
            'serverErrorCategory' => 'CONNECTIVITY_ERROR|CREDENTIAL_ERROR|PERMISSION_ERROR|ARCHITECTURE_ERROR|OTHER_ERROR',
        ],
        'serverType' => '<string>',
        'statusMessage' => '<string>',
        'systemInfo' => [
            'cpuArchitecture' => '<string>',
            'fileSystemType' => '<string>',
            'networkInfoList' => [
                [
                    'interfaceName' => '<string>',
                    'ipAddress' => '<string>',
                    'macAddress' => '<string>',
                    'netMask' => '<string>',
                ],
                // ...
            ],
            'osInfo' => [
                'type' => 'LINUX|WINDOWS',
                'version' => '<string>',
            ],
        ],
    ],
]

Result Details

Members
associatedApplications
Type: Array of AssociatedApplication structures

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

nextToken
Type: string

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

serverDetail
Type: ServerDetail structure

Detailed information about the server.

Errors

ResourceNotFoundException:

The specified ID in the request is not found.

AccessDeniedException:

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request body isn't valid.

InternalServerException:

The server experienced an internal error. Try again.

GetServerStrategies 

$result = $client->getServerStrategies([/* ... */]);
$promise = $client->getServerStrategiesAsync([/* ... */]);

Retrieves recommended strategies and tools for the specified server.

Parameter Syntax

$result = $client->getServerStrategies([
    'serverId' => '<string>', // REQUIRED
]);

Parameter Details

Members
serverId
Required: Yes
Type: string

The ID of the server.

Result Syntax

[
    'serverStrategies' => [
        [
            'isPreferred' => true || false,
            'numberOfApplicationComponents' => <integer>,
            'recommendation' => [
                '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',
                'transformationTool' => [
                    'description' => '<string>',
                    'name' => '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>',
                ],
            ],
            'status' => 'recommended|viableOption|notRecommended|potential',
        ],
        // ...
    ],
]

Result Details

Members
serverStrategies
Type: Array of ServerStrategy structures

A list of strategy recommendations for the server.

Errors

ResourceNotFoundException:

The specified ID in the request is not found.

AccessDeniedException:

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request body isn't valid.

InternalServerException:

The server experienced an internal error. Try again.

ListAnalyzableServers 

$result = $client->listAnalyzableServers([/* ... */]);
$promise = $client->listAnalyzableServersAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listAnalyzableServers([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sort' => 'ASC|DESC',
]);

Parameter Details

Members
maxResults
Type: int

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

nextToken
Type: 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
Type: string

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

Result Syntax

[
    'analyzableServers' => [
        [
            'hostname' => '<string>',
            'ipAddress' => '<string>',
            'source' => '<string>',
            'vmId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
analyzableServers
Type: Array of AnalyzableServerSummary structures

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

nextToken
Type: string

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

Errors

AccessDeniedException:

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request body isn't valid.

InternalServerException:

The server experienced an internal error. Try again.

ListApplicationComponents 

$result = $client->listApplicationComponents([/* ... */]);
$promise = $client->listApplicationComponentsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listApplicationComponents([
    'applicationComponentCriteria' => 'NOT_DEFINED|APP_NAME|SERVER_ID|APP_TYPE|STRATEGY|DESTINATION|ANALYSIS_STATUS|ERROR_CATEGORY',
    'filterValue' => '<string>',
    'groupIdFilter' => [
        [
            'name' => 'ExternalId|ExternalSourceType',
            'value' => '<string>',
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sort' => 'ASC|DESC',
]);

Parameter Details

Members
applicationComponentCriteria
Type: string

Criteria for filtering the list of application components.

filterValue
Type: 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
Type: Array of Group structures

The group ID specified in to filter on.

maxResults
Type: int

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

nextToken
Type: 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
Type: string

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

Result Syntax

[
    'applicationComponentInfos' => [
        [
            'analysisStatus' => 'ANALYSIS_TO_BE_SCHEDULED|ANALYSIS_STARTED|ANALYSIS_SUCCESS|ANALYSIS_FAILED|ANALYSIS_PARTIAL_SUCCESS|UNCONFIGURED|CONFIGURED',
            'antipatternReportS3Object' => [
                's3Bucket' => '<string>',
                's3key' => '<string>',
            ],
            'antipatternReportStatus' => 'FAILED|IN_PROGRESS|SUCCESS',
            'antipatternReportStatusMessage' => '<string>',
            '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',
            'appUnitError' => [
                'appUnitErrorCategory' => 'CREDENTIAL_ERROR|CONNECTIVITY_ERROR|PERMISSION_ERROR|UNSUPPORTED_ERROR|OTHER_ERROR',
            ],
            'associatedServerId' => '<string>',
            'databaseConfigDetail' => [
                'secretName' => '<string>',
            ],
            'id' => '<string>',
            'inclusionStatus' => 'excludeFromAssessment|includeInAssessment',
            'lastAnalyzedTimestamp' => <DateTime>,
            'listAntipatternSeveritySummary' => [
                [
                    'count' => <integer>,
                    'severity' => 'HIGH|MEDIUM|LOW',
                ],
                // ...
            ],
            'moreServerAssociationExists' => true || false,
            'name' => '<string>',
            'osDriver' => '<string>',
            'osVersion' => '<string>',
            'recommendationSet' => [
                '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',
                'transformationTool' => [
                    'description' => '<string>',
                    'name' => '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>',
                ],
            ],
            'resourceSubType' => 'Database|Process|DatabaseProcess',
            'resultList' => [
                [
                    'analysisStatus' => [
                        'runtimeAnalysisStatus' => 'ANALYSIS_TO_BE_SCHEDULED|ANALYSIS_STARTED|ANALYSIS_SUCCESS|ANALYSIS_FAILED',
                        'srcCodeOrDbAnalysisStatus' => 'ANALYSIS_TO_BE_SCHEDULED|ANALYSIS_STARTED|ANALYSIS_SUCCESS|ANALYSIS_FAILED|ANALYSIS_PARTIAL_SUCCESS|UNCONFIGURED|CONFIGURED',
                    ],
                    'analysisType' => 'SOURCE_CODE_ANALYSIS|DATABASE_ANALYSIS|RUNTIME_ANALYSIS|BINARY_ANALYSIS',
                    'antipatternReportResultList' => [
                        [
                            'analyzerName' => [
                                'binaryAnalyzerName' => 'DLL_ANALYZER|BYTECODE_ANALYZER',
                                'runTimeAnalyzerName' => 'A2C_ANALYZER|REHOST_ANALYZER|EMP_PA_ANALYZER|DATABASE_ANALYZER|SCT_ANALYZER',
                                'sourceCodeAnalyzerName' => 'CSHARP_ANALYZER|JAVA_ANALYZER|BYTECODE_ANALYZER|PORTING_ASSISTANT',
                            ],
                            'antiPatternReportS3Object' => [
                                's3Bucket' => '<string>',
                                's3key' => '<string>',
                            ],
                            'antipatternReportStatus' => 'FAILED|IN_PROGRESS|SUCCESS',
                            'antipatternReportStatusMessage' => '<string>',
                        ],
                        // ...
                    ],
                    'statusMessage' => '<string>',
                ],
                // ...
            ],
            'runtimeStatus' => 'ANALYSIS_TO_BE_SCHEDULED|ANALYSIS_STARTED|ANALYSIS_SUCCESS|ANALYSIS_FAILED',
            'runtimeStatusMessage' => '<string>',
            'sourceCodeRepositories' => [
                [
                    'branch' => '<string>',
                    'projectName' => '<string>',
                    'repository' => '<string>',
                    'versionControlType' => '<string>',
                ],
                // ...
            ],
            'statusMessage' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
applicationComponentInfos
Type: Array of ApplicationComponentDetail structures

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

nextToken
Type: string

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

Errors

AccessDeniedException:

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

ServiceLinkedRoleLockClientException:

Exception to indicate that the service-linked role (SLR) is locked.

ValidationException:

The request body isn't valid.

InternalServerException:

The server experienced an internal error. Try again.

ListCollectors 

$result = $client->listCollectors([/* ... */]);
$promise = $client->listCollectorsAsync([/* ... */]);

Retrieves a list of all the installed collectors.

Parameter Syntax

$result = $client->listCollectors([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

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

nextToken
Type: 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.

Result Syntax

[
    'Collectors' => [
        [
            'collectorHealth' => 'COLLECTOR_HEALTHY|COLLECTOR_UNHEALTHY',
            'collectorId' => '<string>',
            'collectorVersion' => '<string>',
            'configurationSummary' => [
                'ipAddressBasedRemoteInfoList' => [
                    [
                        'authType' => 'NTLM|SSH|CERT',
                        'ipAddressConfigurationTimeStamp' => '<string>',
                        'osType' => 'LINUX|WINDOWS',
                    ],
                    // ...
                ],
                'pipelineInfoList' => [
                    [
                        'pipelineConfigurationTimeStamp' => '<string>',
                        'pipelineType' => 'AZURE_DEVOPS',
                    ],
                    // ...
                ],
                'remoteSourceCodeAnalysisServerInfo' => [
                    'remoteSourceCodeAnalysisServerConfigurationTimestamp' => '<string>',
                ],
                'vcenterBasedRemoteInfoList' => [
                    [
                        'osType' => 'LINUX|WINDOWS',
                        'vcenterConfigurationTimeStamp' => '<string>',
                    ],
                    // ...
                ],
                'versionControlInfoList' => [
                    [
                        'versionControlConfigurationTimeStamp' => '<string>',
                        'versionControlType' => 'GITHUB|GITHUB_ENTERPRISE|AZURE_DEVOPS_GIT',
                    ],
                    // ...
                ],
            ],
            'hostName' => '<string>',
            'ipAddress' => '<string>',
            'lastActivityTimeStamp' => '<string>',
            'registeredTimeStamp' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
Collectors
Type: Array of Collector structures

The list of all the installed collectors.

nextToken
Type: string

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

Errors

AccessDeniedException:

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request body isn't valid.

InternalServerException:

The server experienced an internal error. Try again.

ListImportFileTask 

$result = $client->listImportFileTask([/* ... */]);
$promise = $client->listImportFileTaskAsync([/* ... */]);

Retrieves a list of all the imports performed.

Parameter Syntax

$result = $client->listImportFileTask([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

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

nextToken
Type: 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.

Result Syntax

[
    'nextToken' => '<string>',
    'taskInfos' => [
        [
            'completionTime' => <DateTime>,
            'id' => '<string>',
            'importName' => '<string>',
            'inputS3Bucket' => '<string>',
            'inputS3Key' => '<string>',
            'numberOfRecordsFailed' => <integer>,
            'numberOfRecordsSuccess' => <integer>,
            'startTime' => <DateTime>,
            'status' => 'ImportInProgress|ImportFailed|ImportPartialSuccess|ImportSuccess|DeleteInProgress|DeleteFailed|DeletePartialSuccess|DeleteSuccess',
            'statusReportS3Bucket' => '<string>',
            'statusReportS3Key' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

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

taskInfos
Type: Array of ImportFileTaskInformation structures

Lists information about the files you import.

Errors

AccessDeniedException:

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request body isn't valid.

InternalServerException:

The server experienced an internal error. Try again.

ListServers 

$result = $client->listServers([/* ... */]);
$promise = $client->listServersAsync([/* ... */]);

Returns a list of all the servers.

Parameter Syntax

$result = $client->listServers([
    'filterValue' => '<string>',
    'groupIdFilter' => [
        [
            'name' => 'ExternalId|ExternalSourceType',
            'value' => '<string>',
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'serverCriteria' => 'NOT_DEFINED|OS_NAME|STRATEGY|DESTINATION|SERVER_ID|ANALYSIS_STATUS|ERROR_CATEGORY',
    'sort' => 'ASC|DESC',
]);

Parameter Details

Members
filterValue
Type: 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
Type: Array of Group structures

Specifies the group ID to filter on.

maxResults
Type: int

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

nextToken
Type: 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
Type: string

Criteria for filtering servers.

sort
Type: string

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

Result Syntax

[
    'nextToken' => '<string>',
    'serverInfos' => [
        [
            'antipatternReportS3Object' => [
                's3Bucket' => '<string>',
                's3key' => '<string>',
            ],
            'antipatternReportStatus' => 'FAILED|IN_PROGRESS|SUCCESS',
            'antipatternReportStatusMessage' => '<string>',
            'applicationComponentStrategySummary' => [
                [
                    'count' => <integer>,
                    'strategy' => 'Rehost|Retirement|Refactor|Replatform|Retain|Relocate|Repurchase',
                ],
                // ...
            ],
            'dataCollectionStatus' => 'dataCollectionTaskToBeScheduled|dataCollectionTaskScheduled|dataCollectionTaskStarted|dataCollectionTaskStopped|dataCollectionTaskSuccess|dataCollectionTaskFailed|dataCollectionTaskPartialSuccess',
            'id' => '<string>',
            'lastAnalyzedTimestamp' => <DateTime>,
            'listAntipatternSeveritySummary' => [
                [
                    'count' => <integer>,
                    'severity' => 'HIGH|MEDIUM|LOW',
                ],
                // ...
            ],
            'name' => '<string>',
            'recommendationSet' => [
                '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',
                'transformationTool' => [
                    'description' => '<string>',
                    'name' => '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>',
                ],
            ],
            'serverError' => [
                'serverErrorCategory' => 'CONNECTIVITY_ERROR|CREDENTIAL_ERROR|PERMISSION_ERROR|ARCHITECTURE_ERROR|OTHER_ERROR',
            ],
            'serverType' => '<string>',
            'statusMessage' => '<string>',
            'systemInfo' => [
                'cpuArchitecture' => '<string>',
                'fileSystemType' => '<string>',
                'networkInfoList' => [
                    [
                        'interfaceName' => '<string>',
                        'ipAddress' => '<string>',
                        'macAddress' => '<string>',
                        'netMask' => '<string>',
                    ],
                    // ...
                ],
                'osInfo' => [
                    'type' => 'LINUX|WINDOWS',
                    'version' => '<string>',
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

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

serverInfos
Type: Array of ServerDetail structures

The list of servers with detailed information about each server.

Errors

AccessDeniedException:

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request body isn't valid.

InternalServerException:

The server experienced an internal error. Try again.

PutPortfolioPreferences 

$result = $client->putPortfolioPreferences([/* ... */]);
$promise = $client->putPortfolioPreferencesAsync([/* ... */]);

Saves the specified migration and modernization preferences.

Parameter Syntax

$result = $client->putPortfolioPreferences([
    'applicationMode' => 'ALL|KNOWN|UNKNOWN',
    'applicationPreferences' => [
        'managementPreference' => [
            'awsManagedResources' => [
                'targetDestination' => ['<string>', ...], // REQUIRED
            ],
            'noPreference' => [
                'targetDestination' => ['<string>', ...], // REQUIRED
            ],
            'selfManageResources' => [
                'targetDestination' => ['<string>', ...], // REQUIRED
            ],
        ],
    ],
    'databasePreferences' => [
        'databaseManagementPreference' => 'AWS-managed|Self-manage|No preference',
        'databaseMigrationPreference' => [
            'heterogeneous' => [
                'targetDatabaseEngine' => ['<string>', ...], // REQUIRED
            ],
            'homogeneous' => [
                'targetDatabaseEngine' => ['<string>', ...],
            ],
            'noPreference' => [
                'targetDatabaseEngine' => ['<string>', ...], // REQUIRED
            ],
        ],
    ],
    'prioritizeBusinessGoals' => [
        'businessGoals' => [
            'licenseCostReduction' => <integer>,
            'modernizeInfrastructureWithCloudNativeTechnologies' => <integer>,
            'reduceOperationalOverheadWithManagedServices' => <integer>,
            'speedOfMigration' => <integer>,
        ],
    ],
]);

Parameter Details

Members
applicationMode
Type: string

The classification for application component types.

applicationPreferences
Type: ApplicationPreferences structure

The transformation preferences for non-database applications.

databasePreferences
Type: DatabasePreferences structure

The transformation preferences for database applications.

prioritizeBusinessGoals
Type: PrioritizeBusinessGoals structure

The rank of the business goals based on priority.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request body isn't valid.

ConflictException:

Exception to indicate that there is an ongoing task when a new task is created. Return when once the existing tasks are complete.

InternalServerException:

The server experienced an internal error. Try again.

StartAssessment 

$result = $client->startAssessment([/* ... */]);
$promise = $client->startAssessmentAsync([/* ... */]);

Starts the assessment of an on-premises environment.

Parameter Syntax

$result = $client->startAssessment([
    'assessmentDataSourceType' => 'StrategyRecommendationsApplicationDataCollector|ManualImport|ApplicationDiscoveryService',
    'assessmentTargets' => [
        [
            'condition' => 'EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS', // REQUIRED
            'name' => '<string>', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    's3bucketForAnalysisData' => '<string>',
    's3bucketForReportData' => '<string>',
]);

Parameter Details

Members
assessmentDataSourceType
Type: string

The data source type of an assessment to be started.

assessmentTargets
Type: Array of AssessmentTarget structures

List of criteria for assessment.

s3bucketForAnalysisData
Type: string

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

s3bucketForReportData
Type: string

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

Result Syntax

[
    'assessmentId' => '<string>',
]

Result Details

Members
assessmentId
Type: string

The ID of the assessment.

Errors

AccessDeniedException:

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

The AWS account has reached its quota of imports. Contact AWS Support to increase the quota for this account.

InternalServerException:

The server experienced an internal error. Try again.

StartImportFileTask 

$result = $client->startImportFileTask([/* ... */]);
$promise = $client->startImportFileTaskAsync([/* ... */]);

Starts a file import.

Parameter Syntax

$result = $client->startImportFileTask([
    'S3Bucket' => '<string>', // REQUIRED
    'dataSourceType' => 'ApplicationDiscoveryService|MPA|Import|StrategyRecommendationsApplicationDataCollector',
    'groupId' => [
        [
            'name' => 'ExternalId|ExternalSourceType',
            'value' => '<string>',
        ],
        // ...
    ],
    'name' => '<string>', // REQUIRED
    's3bucketForReportData' => '<string>',
    's3key' => '<string>', // REQUIRED
]);

Parameter Details

Members
S3Bucket
Required: Yes
Type: string

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

dataSourceType
Type: string

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

groupId
Type: Array of Group structures

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

name
Required: Yes
Type: string

A descriptive name for the request.

s3bucketForReportData
Type: string

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

s3key
Required: Yes
Type: string

The Amazon S3 key name of the import file.

Result Syntax

[
    'id' => '<string>',
]

Result Details

Members
id
Type: string

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

Errors

AccessDeniedException:

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

The AWS account has reached its quota of imports. Contact AWS Support to increase the quota for this account.

ValidationException:

The request body isn't valid.

InternalServerException:

The server experienced an internal error. Try again.

StartRecommendationReportGeneration 

$result = $client->startRecommendationReportGeneration([/* ... */]);
$promise = $client->startRecommendationReportGenerationAsync([/* ... */]);

Starts generating a recommendation report.

Parameter Syntax

$result = $client->startRecommendationReportGeneration([
    'groupIdFilter' => [
        [
            'name' => 'ExternalId|ExternalSourceType',
            'value' => '<string>',
        ],
        // ...
    ],
    'outputFormat' => 'Excel|Json',
]);

Parameter Details

Members
groupIdFilter
Type: Array of Group structures

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

outputFormat
Type: string

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

Result Syntax

[
    'id' => '<string>',
]

Result Details

Members
id
Type: string

The ID of the recommendation report generation task.

Errors

AccessDeniedException:

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request body isn't valid.

ConflictException:

Exception to indicate that there is an ongoing task when a new task is created. Return when once the existing tasks are complete.

InternalServerException:

The server experienced an internal error. Try again.

StopAssessment 

$result = $client->stopAssessment([/* ... */]);
$promise = $client->stopAssessmentAsync([/* ... */]);

Stops the assessment of an on-premises environment.

Parameter Syntax

$result = $client->stopAssessment([
    'assessmentId' => '<string>', // REQUIRED
]);

Parameter Details

Members
assessmentId
Required: Yes
Type: string

The assessmentId returned by StartAssessment.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request body isn't valid.

InternalServerException:

The server experienced an internal error. Try again.

UpdateApplicationComponentConfig 

$result = $client->updateApplicationComponentConfig([/* ... */]);
$promise = $client->updateApplicationComponentConfigAsync([/* ... */]);

Updates the configuration of an application component.

Parameter Syntax

$result = $client->updateApplicationComponentConfig([
    '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',
    'applicationComponentId' => '<string>', // REQUIRED
    'configureOnly' => true || false,
    'inclusionStatus' => 'excludeFromAssessment|includeInAssessment',
    'secretsManagerKey' => '<string>',
    'sourceCodeList' => [
        [
            'location' => '<string>',
            'projectName' => '<string>',
            'sourceVersion' => '<string>',
            'versionControl' => 'GITHUB|GITHUB_ENTERPRISE|AZURE_DEVOPS_GIT',
        ],
        // ...
    ],
    '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',
    ],
]);

Parameter Details

Members
appType
Type: string

The type of known component.

applicationComponentId
Required: Yes
Type: string

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

configureOnly
Type: 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
Type: string

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

secretsManagerKey
Type: string

Database credentials.

sourceCodeList
Type: Array of SourceCode structures

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

strategyOption
Type: StrategyOption structure

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

The specified ID in the request is not found.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request body isn't valid.

InternalServerException:

The server experienced an internal error. Try again.

UpdateServerConfig 

$result = $client->updateServerConfig([/* ... */]);
$promise = $client->updateServerConfigAsync([/* ... */]);

Updates the configuration of the specified server.

Parameter Syntax

$result = $client->updateServerConfig([
    'serverId' => '<string>', // 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',
    ],
]);

Parameter Details

Members
serverId
Required: Yes
Type: string

The ID of the server.

strategyOption
Type: StrategyOption structure

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

The specified ID in the request is not found.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request body isn't valid.

InternalServerException:

The server experienced an internal error. Try again.

Shapes

AccessDeniedException

Description

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

Members
message
Required: Yes
Type: string

AnalysisStatusUnion

Description

A combination of existing analysis statuses.

Members
runtimeAnalysisStatus
Type: string

The status of the analysis.

srcCodeOrDbAnalysisStatus
Type: string

The status of the source code or database analysis.

AnalyzableServerSummary

Description

Summary information about an analyzable server.

Members
hostname
Type: string

The host name of the analyzable server.

ipAddress
Type: string

The ip address of the analyzable server.

source
Type: string

The data source of the analyzable server.

vmId
Type: string

The virtual machine id of the analyzable server.

AnalyzerNameUnion

Description

The combination of the existing analyzers.

Members
binaryAnalyzerName
Type: string

The binary analyzer names.

runTimeAnalyzerName
Type: string

The assessment analyzer names.

sourceCodeAnalyzerName
Type: string

The source code analyzer names.

AntipatternReportResult

Description

The anti-pattern report result.

Members
analyzerName
Type: AnalyzerNameUnion structure

The analyzer name.

antiPatternReportS3Object
Type: S3Object structure

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

antipatternReportStatus
Type: string

The status of the anti-pattern report generation.

antipatternReportStatusMessage
Type: string

The status message for the anti-pattern.

AntipatternSeveritySummary

Description

Contains the summary of anti-patterns and their severity.

Members
count
Type: int

Contains the count of anti-patterns.

severity
Type: string

Contains the severity of anti-patterns.

AppUnitError

Description

Error in the analysis of the application unit.

Members
appUnitErrorCategory
Type: string

The category of the error.

ApplicationComponentDetail

Description

Contains detailed information about an application component.

Members
analysisStatus
Type: string

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

antipatternReportS3Object
Type: S3Object structure

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

antipatternReportStatus
Type: string

The status of the anti-pattern report generation.

antipatternReportStatusMessage
Type: string

The status message for the anti-pattern.

appType
Type: string

The type of application component.

appUnitError
Type: AppUnitError structure

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

associatedServerId
Type: string

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

databaseConfigDetail
Type: DatabaseConfigDetail structure

Configuration details for the database associated with the application component.

id
Type: string

The ID of the application component.

inclusionStatus
Type: string

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

lastAnalyzedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the application component was assessed.

listAntipatternSeveritySummary
Type: Array of AntipatternSeveritySummary structures

A list of anti-pattern severity summaries.

moreServerAssociationExists
Type: boolean

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

name
Type: string

The name of application component.

osDriver
Type: string

OS driver.

osVersion
Type: string

OS version.

recommendationSet
Type: RecommendationSet structure

The top recommendation set for the application component.

resourceSubType
Type: string

The application component subtype.

resultList
Type: Array of Result structures

A list of the analysis results.

runtimeStatus
Type: string

The status of the application unit.

runtimeStatusMessage
Type: string

The status message for the application unit.

sourceCodeRepositories
Type: Array of SourceCodeRepository structures

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

statusMessage
Type: string

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

ApplicationComponentStatusSummary

Description

Summary of the analysis status of the application component.

Members
count
Type: int

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

srcCodeOrDbAnalysisStatus
Type: string

The status of database analysis.

ApplicationComponentStrategy

Description

Contains information about a strategy recommendation for an application component.

Members
isPreferred
Type: boolean

Set to true if the recommendation is set as preferred.

recommendation
Type: RecommendationSet structure

Strategy recommendation for the application component.

status
Type: string

The recommendation status of a strategy for an application component.

ApplicationComponentSummary

Description

Contains the summary of application components.

Members
appType
Type: string

Contains the name of application types.

count
Type: int

Contains the count of application type.

ApplicationPreferences

Description

Application preferences that you specify.

Members
managementPreference
Type: ManagementPreference structure

Application preferences that you specify to prefer managed environment.

AssessmentSummary

Description

Contains the summary of the assessment results.

Members
antipatternReportS3Object
Type: S3Object structure

The Amazon S3 object containing the anti-pattern report.

antipatternReportStatus
Type: string

The status of the anti-pattern report.

antipatternReportStatusMessage
Type: string

The status message of the anti-pattern report.

lastAnalyzedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the assessment was performed.

listAntipatternSeveritySummary
Type: Array of AntipatternSeveritySummary structures

List of AntipatternSeveritySummary.

listApplicationComponentStatusSummary
Type: Array of ApplicationComponentStatusSummary structures

List of status summaries of the analyzed application components.

listApplicationComponentStrategySummary
Type: Array of StrategySummary structures

List of ApplicationComponentStrategySummary.

listApplicationComponentSummary
Type: Array of ApplicationComponentSummary structures

List of ApplicationComponentSummary.

listServerStatusSummary
Type: Array of ServerStatusSummary structures

List of status summaries of the analyzed servers.

listServerStrategySummary
Type: Array of StrategySummary structures

List of ServerStrategySummary.

listServerSummary
Type: Array of ServerSummary structures

List of ServerSummary.

AssessmentTarget

Description

Defines the criteria of assessment.

Members
condition
Required: Yes
Type: string

Condition of an assessment.

name
Required: Yes
Type: string

Name of an assessment.

values
Required: Yes
Type: Array of strings

Values of an assessment.

AssociatedApplication

Description

Object containing details about applications as defined in Application Discovery Service.

Members
id
Type: string

ID of the application as defined in Application Discovery Service.

name
Type: string

Name of the application as defined in Application Discovery Service.

AwsManagedResources

Description

Object containing the choice of application destination that you specify.

Members
targetDestination
Required: Yes
Type: Array of strings

The choice of application destination that you specify.

BusinessGoals

Description

Business goals that you specify.

Members
licenseCostReduction
Type: int

Business goal to reduce license costs.

modernizeInfrastructureWithCloudNativeTechnologies
Type: int

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

reduceOperationalOverheadWithManagedServices
Type: int

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

speedOfMigration
Type: int

Business goal to achieve migration at a fast pace.

Collector

Description

Process data collector that runs in the environment that you specify.

Members
collectorHealth
Type: string

Indicates the health of a collector.

collectorId
Type: string

The ID of the collector.

collectorVersion
Type: string

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

configurationSummary
Type: ConfigurationSummary structure

Summary of the collector configuration.

hostName
Type: string

Hostname of the server that is hosting the collector.

ipAddress
Type: string

IP address of the server that is hosting the collector.

lastActivityTimeStamp
Type: string

Time when the collector last pinged the service.

registeredTimeStamp
Type: string

Time when the collector registered with the service.

ConfigurationSummary

Description

Summary of the collector configuration.

Members
ipAddressBasedRemoteInfoList
Type: Array of IPAddressBasedRemoteInfo structures

IP address based configurations.

pipelineInfoList
Type: Array of PipelineInfo structures

The list of pipeline info configurations.

remoteSourceCodeAnalysisServerInfo
Type: RemoteSourceCodeAnalysisServerInfo structure

Info about the remote server source code configuration.

vcenterBasedRemoteInfoList
Type: Array of VcenterBasedRemoteInfo structures

The list of vCenter configurations.

versionControlInfoList
Type: Array of VersionControlInfo structures

The list of the version control configurations.

ConflictException

Description

Exception to indicate that there is an ongoing task when a new task is created. Return when once the existing tasks are complete.

Members
message
Required: Yes
Type: string

DataCollectionDetails

Description

Detailed information about an assessment.

Members
completionTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the assessment completes.

failed
Type: int

The number of failed servers in the assessment.

inProgress
Type: int

The number of servers with the assessment status IN_PROGESS.

servers
Type: int

The total number of servers in the assessment.

startTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time of assessment.

status
Type: string

The status of the assessment.

statusMessage
Type: string

The status message of the assessment.

success
Type: int

The number of successful servers in the assessment.

DatabaseConfigDetail

Description

Configuration information used for assessing databases.

Members
secretName
Type: string

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

DatabaseMigrationPreference

Description

Preferences for migrating a database to AWS.

Members
heterogeneous
Type: Heterogeneous structure

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.

homogeneous
Type: Homogeneous structure

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.

noPreference
Type: NoDatabaseMigrationPreference structure

Indicated that you do not prefer heterogeneous or homogeneous.

DatabasePreferences

Description

Preferences on managing your databases on AWS.

Members
databaseManagementPreference
Type: string

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

databaseMigrationPreference
Type: DatabaseMigrationPreference structure

Specifies your preferred migration path.

DependencyException

Description

Dependency encountered an error.

Members
message
Type: string

Group

Description

The object containing information about distinct imports or groups for Strategy Recommendations.

Members
name
Type: string

The key of the specific import group.

value
Type: string

The value of the specific import group.

Heterogeneous

Description

The object containing details about heterogeneous database preferences.

Members
targetDatabaseEngine
Required: Yes
Type: Array of strings

The target database engine for heterogeneous database migration preference.

Homogeneous

Description

The object containing details about homogeneous database preferences.

Members
targetDatabaseEngine
Type: Array of strings

The target database engine for homogeneous database migration preferences.

IPAddressBasedRemoteInfo

Description

IP address based configurations.

Members
authType
Type: string

The type of authorization.

ipAddressConfigurationTimeStamp
Type: string

The time stamp of the configuration.

osType
Type: string

The type of the operating system.

ImportFileTaskInformation

Description

Information about the import file tasks you request.

Members
completionTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the import task completes.

id
Type: string

The ID of the import file task.

importName
Type: string

The name of the import task given in StartImportFileTask.

inputS3Bucket
Type: string

The S3 bucket where the import file is located.

inputS3Key
Type: string

The Amazon S3 key name of the import file.

numberOfRecordsFailed
Type: int

The number of records that failed to be imported.

numberOfRecordsSuccess
Type: int

The number of records successfully imported.

startTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Start time of the import task.

status
Type: string

Status of import file task.

statusReportS3Bucket
Type: string

The S3 bucket name for status report of import task.

statusReportS3Key
Type: 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.

InternalServerException

Description

The server experienced an internal error. Try again.

Members
message
Type: string

ManagementPreference

Description

Preferences for migrating an application to AWS.

Members
awsManagedResources
Type: AwsManagedResources structure

Indicates interest in solutions that are managed by AWS.

noPreference
Type: NoManagementPreference structure

No specific preference.

selfManageResources
Type: SelfManageResources structure

Indicates interest in managing your own resources on AWS.

NetworkInfo

Description

Information about the server's network for which the assessment was run.

Members
interfaceName
Required: Yes
Type: string

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

ipAddress
Required: Yes
Type: string

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

macAddress
Required: Yes
Type: string

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

netMask
Required: Yes
Type: string

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

NoDatabaseMigrationPreference

Description

The object containing details about database migration preferences, when you have no particular preference.

Members
targetDatabaseEngine
Required: Yes
Type: Array of strings

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

NoManagementPreference

Description

Object containing the choice of application destination that you specify.

Members
targetDestination
Required: Yes
Type: Array of strings

The choice of application destination that you specify.

OSInfo

Description

Information about the operating system.

Members
type
Type: string

Information about the type of operating system.

version
Type: string

Information about the version of operating system.

PipelineInfo

Description

Detailed information of the pipeline.

Members
pipelineConfigurationTimeStamp
Type: string

The time when the pipeline info was configured.

pipelineType
Type: string

The type of pipeline.

PrioritizeBusinessGoals

Description

Rank of business goals based on priority.

Members
businessGoals
Type: BusinessGoals structure

Rank of business goals based on priority.

RecommendationReportDetails

Description

Contains detailed information about a recommendation report.

Members
completionTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the recommendation report generation task completes.

s3Bucket
Type: string

The S3 bucket where the report file is located.

s3Keys
Type: Array of strings

The Amazon S3 key name of the report file.

startTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the recommendation report generation task starts.

status
Type: string

The status of the recommendation report generation task.

statusMessage
Type: string

The status message for recommendation report generation.

RecommendationSet

Description

Contains a recommendation set.

Members
strategy
Type: string

The recommended strategy.

targetDestination
Type: string

The recommended target destination.

transformationTool
Type: TransformationTool structure

The target destination for the recommendation set.

RemoteSourceCodeAnalysisServerInfo

Description

Information about the server configured for source code analysis.

Members
remoteSourceCodeAnalysisServerConfigurationTimestamp
Type: string

The time when the remote source code server was configured.

ResourceNotFoundException

Description

The specified ID in the request is not found.

Members
message
Type: string

Result

Description

The error in server analysis.

Members
analysisStatus
Type: AnalysisStatusUnion structure

The error in server analysis.

analysisType
Type: string

The error in server analysis.

antipatternReportResultList
Type: Array of AntipatternReportResult structures

The error in server analysis.

statusMessage
Type: string

The error in server analysis.

S3Object

Description

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

Members
s3Bucket
Type: string

The S3 bucket name.

s3key
Type: string

The Amazon S3 key name.

SelfManageResources

Description

Self-managed resources.

Members
targetDestination
Required: Yes
Type: Array of strings

Self-managed resources target destination.

ServerDetail

Description

Detailed information about a server.

Members
antipatternReportS3Object
Type: S3Object structure

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

antipatternReportStatus
Type: string

The status of the anti-pattern report generation.

antipatternReportStatusMessage
Type: string

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

applicationComponentStrategySummary
Type: Array of StrategySummary structures

A list of strategy summaries.

dataCollectionStatus
Type: string

The status of assessment for the server.

id
Type: string

The server ID.

lastAnalyzedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the server was assessed.

listAntipatternSeveritySummary
Type: Array of AntipatternSeveritySummary structures

A list of anti-pattern severity summaries.

name
Type: string

The name of the server.

recommendationSet
Type: RecommendationSet structure

A set of recommendations.

serverError
Type: ServerError structure

The error in server analysis.

serverType
Type: string

The type of server.

statusMessage
Type: string

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

systemInfo
Type: SystemInfo structure

System information about the server.

ServerError

Description

The error in server analysis.

Members
serverErrorCategory
Type: string

The error category of server analysis.

ServerStatusSummary

Description

The status summary of the server analysis.

Members
count
Type: int

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

runTimeAssessmentStatus
Type: string

The status of the run time.

ServerStrategy

Description

Contains information about a strategy recommendation for a server.

Members
isPreferred
Type: boolean

Set to true if the recommendation is set as preferred.

numberOfApplicationComponents
Type: int

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

recommendation
Type: RecommendationSet structure

Strategy recommendation for the server.

status
Type: string

The recommendation status of the strategy for the server.

ServerSummary

Description

Object containing details about the servers imported by Application Discovery Service

Members
ServerOsType
Type: string

Type of operating system for the servers.

count
Type: int

Number of servers.

ServiceLinkedRoleLockClientException

Description

Exception to indicate that the service-linked role (SLR) is locked.

Members
message
Type: string

ServiceQuotaExceededException

Description

The AWS account has reached its quota of imports. Contact AWS Support to increase the quota for this account.

Members
message
Required: Yes
Type: string

SourceCode

Description

Object containing source code information that is linked to an application component.

Members
location
Type: string

The repository name for the source code.

projectName
Type: string

The name of the project.

sourceVersion
Type: string

The branch of the source code.

versionControl
Type: string

The type of repository to use for the source code.

SourceCodeRepository

Description

Object containing source code information that is linked to an application component.

Members
branch
Type: string

The branch of the source code.

projectName
Type: string

The name of the project.

repository
Type: string

The repository name for the source code.

versionControlType
Type: string

The type of repository to use for the source code.

StrategyOption

Description

Information about all the available strategy options for migrating and modernizing an application component.

Members
isPreferred
Type: boolean

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

strategy
Type: string

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

targetDestination
Type: string

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

toolName
Type: string

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

StrategySummary

Description

Object containing the summary of the strategy recommendations.

Members
count
Type: int

The count of recommendations per strategy.

strategy
Type: string

The name of recommended strategy.

SystemInfo

Description

Information about the server that hosts application components.

Members
cpuArchitecture
Type: string

CPU architecture type for the server.

fileSystemType
Type: string

File system type for the server.

networkInfoList
Type: Array of NetworkInfo structures

Networking information related to a server.

osInfo
Type: OSInfo structure

Operating system corresponding to a server.

ThrottlingException

Description

The request was denied due to request throttling.

Members
message
Type: string

TransformationTool

Description

Information of the transformation tool that can be used to migrate and modernize the application.

Members
description
Type: string

Description of the tool.

name
Type: string

Name of the tool.

tranformationToolInstallationLink
Type: string

URL for installing the tool.

ValidationException

Description

The request body isn't valid.

Members
message
Type: string

VcenterBasedRemoteInfo

Description

Details about the server in vCenter.

Members
osType
Type: string

The type of the operating system.

vcenterConfigurationTimeStamp
Type: string

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

VersionControlInfo

Description

Details about the version control configuration.

Members
versionControlConfigurationTimeStamp
Type: string

The time when the version control system was last configured.

versionControlType
Type: string

The type of version control.