<p>This API reference provides descriptions, syntax, and other details about each of the actions and data types for Migration Hub Strategy Recommendations (Strategy Recommendations). The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see <a href="http://aws.amazon.com/tools/#SDKs">AWS SDKs</a>.</p> Retrieves details about an application component.
", "GetApplicationComponentStrategies": "Retrieves a list of all the recommended strategies and tools for an application component running on a server.
", "GetAssessment": "Retrieves the status of an on-going assessment.
", "GetImportFileTask": "Retrieves the details about a specific import task.
", "GetPortfolioPreferences": "Retrieves your migration and modernization preferences.
", "GetPortfolioSummary": "Retrieves overall summary including the number of servers to rehost and the overall number of anti-patterns.
", "GetRecommendationReportDetails": "Retrieves detailed information about the specified recommendation report.
", "GetServerDetails": "Retrieves detailed information about a specified server.
", "GetServerStrategies": "Retrieves recommended strategies and tools for the specified server.
", "ListApplicationComponents": "Retrieves a list of all the application components (processes).
", "ListCollectors": "Retrieves a list of all the installed collectors.
", "ListImportFileTask": "Retrieves a list of all the imports performed.
", "ListServers": "Returns a list of all the servers.
", "PutPortfolioPreferences": "Saves the specified migration and modernization preferences.
", "StartAssessment": "Starts the assessment of an on-premises environment.
", "StartImportFileTask": "Starts a file import.
", "StartRecommendationReportGeneration": "Starts generating a recommendation report.
", "StopAssessment": "Stops the assessment of an on-premises environment.
", "UpdateApplicationComponentConfig": "Updates the configuration of an application component.
", "UpdateServerConfig": "Updates the configuration of the specified server.
" }, "shapes": { "AccessDeniedException": { "base": "The AWS user account does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this account.
", "refs": { } }, "AntipatternReportStatus": { "base": null, "refs": { "ApplicationComponentDetail$antipatternReportStatus": "The status of the anti-pattern report generation.
", "AssessmentSummary$antipatternReportStatus": "The status of the anti-pattern report.
", "ServerDetail$antipatternReportStatus": "The status of the anti-pattern report generation.
" } }, "AntipatternSeveritySummary": { "base": "Contains the summary of anti-patterns and their severity.
", "refs": { "ListAntipatternSeveritySummary$member": null } }, "AppType": { "base": null, "refs": { "ApplicationComponentDetail$appType": "The type of application component.
", "ApplicationComponentSummary$appType": "Contains the name of application types.
" } }, "ApplicationComponentCriteria": { "base": null, "refs": { "ListApplicationComponentsRequest$applicationComponentCriteria": "Criteria for filtering the list of application components.
" } }, "ApplicationComponentDetail": { "base": "Contains detailed information about an application component.
", "refs": { "ApplicationComponentDetails$member": null, "GetApplicationComponentDetailsResponse$applicationComponentDetail": "Detailed information about an application component.
" } }, "ApplicationComponentDetails": { "base": null, "refs": { "ListApplicationComponentsResponse$applicationComponentInfos": "The list of application components with detailed information about each component.
" } }, "ApplicationComponentId": { "base": null, "refs": { "GetApplicationComponentDetailsRequest$applicationComponentId": "The ID of the application component. The ID is unique within an AWS account.
", "GetApplicationComponentStrategiesRequest$applicationComponentId": "The ID of the application component. The ID is unique within an AWS account.
", "UpdateApplicationComponentConfigRequest$applicationComponentId": "The ID of the application component. The ID is unique within an AWS account.
" } }, "ApplicationComponentStrategies": { "base": null, "refs": { "GetApplicationComponentStrategiesResponse$applicationComponentStrategies": "A list of application component strategy recommendations.
" } }, "ApplicationComponentStrategy": { "base": "Contains information about a strategy recommendation for an application component.
", "refs": { "ApplicationComponentStrategies$member": null } }, "ApplicationComponentSummary": { "base": "Contains the summary of application components.
", "refs": { "ListApplicationComponentSummary$member": null } }, "ApplicationPreferences": { "base": "Application preferences that you specify.
", "refs": { "GetPortfolioPreferencesResponse$applicationPreferences": "The transformation preferences for non-database applications.
", "PutPortfolioPreferencesRequest$applicationPreferences": "The transformation preferences for non-database applications.
" } }, "AssessmentStatus": { "base": null, "refs": { "DataCollectionDetails$status": "The status of the assessment.
" } }, "AssessmentSummary": { "base": "Contains the summary of the assessment results.
", "refs": { "GetPortfolioSummaryResponse$assessmentSummary": "An assessment summary for the portfolio including the number of servers to rehost and the overall number of anti-patterns.
" } }, "AssociatedApplication": { "base": "Object containing details about applications as defined in Application Discovery Service.
", "refs": { "AssociatedApplications$member": null } }, "AssociatedApplications": { "base": null, "refs": { "GetApplicationComponentDetailsResponse$associatedApplications": "The associated application group as defined in AWS Application Discovery Service.
", "GetServerDetailsResponse$associatedApplications": "The associated application group the server belongs to, as defined in AWS Application Discovery Service.
" } }, "AssociatedServerIDs": { "base": null, "refs": { "GetApplicationComponentDetailsResponse$associatedServerIds": "A list of the IDs of the servers on which the application component is running.
" } }, "AsyncTaskId": { "base": null, "refs": { "GetAssessmentRequest$id": " The assessmentid returned by StartAssessment.
The ID for the specific assessment task.
", "StartAssessmentResponse$assessmentId": "The ID of the assessment.
", "StopAssessmentRequest$assessmentId": " The assessmentId returned by StartAssessment.
Object containing the choice of application destination that you specify.
", "refs": { "ManagementPreference$awsManagedResources": "Indicates interest in solutions that are managed by AWS.
" } }, "AwsManagedTargetDestination": { "base": null, "refs": { "AwsManagedTargetDestinations$member": null } }, "AwsManagedTargetDestinations": { "base": null, "refs": { "AwsManagedResources$targetDestination": "The choice of application destination that you specify.
" } }, "Boolean": { "base": null, "refs": { "ApplicationComponentDetail$moreServerAssociationExists": "Set to true if the application component is running on multiple servers.
", "ApplicationComponentStrategy$isPreferred": "Set to true if the recommendation is set as preferred.
", "GetApplicationComponentDetailsResponse$moreApplicationResource": "Set to true if the application component belongs to more than one application group.
", "ServerStrategy$isPreferred": "Set to true if the recommendation is set as preferred.
", "StrategyOption$isPreferred": "Indicates if a specific strategy is preferred for the application component.
" } }, "BusinessGoals": { "base": "Business goals that you specify.
", "refs": { "PrioritizeBusinessGoals$businessGoals": "Rank of business goals based on priority.
" } }, "BusinessGoalsInteger": { "base": null, "refs": { "BusinessGoals$licenseCostReduction": "Business goal to reduce license costs.
", "BusinessGoals$modernizeInfrastructureWithCloudNativeTechnologies": "Business goal to modernize infrastructure by moving to cloud native technologies.
", "BusinessGoals$reduceOperationalOverheadWithManagedServices": "Business goal to reduce the operational overhead on the team by moving into managed services.
", "BusinessGoals$speedOfMigration": "Business goal to achieve migration at a fast pace.
" } }, "Collector": { "base": "Process data collector that runs in the environment that you specify.
", "refs": { "Collectors$member": null } }, "CollectorHealth": { "base": null, "refs": { "Collector$collectorHealth": "Indicates the health of a collector.
" } }, "Collectors": { "base": null, "refs": { "ListCollectorsResponse$Collectors": "The list of all the installed collectors.
" } }, "ConflictException": { "base": "Exception to indicate that there is an ongoing task when a new task is created. Return when once the existing tasks are complete.
", "refs": { } }, "DataCollectionDetails": { "base": "Detailed information about an assessment.
", "refs": { "GetAssessmentResponse$dataCollectionDetails": "Detailed information about the assessment.
" } }, "DataSourceType": { "base": null, "refs": { "StartImportFileTaskRequest$dataSourceType": "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.
" } }, "DatabaseConfigDetail": { "base": "Configuration information used for assessing databases.
", "refs": { "ApplicationComponentDetail$databaseConfigDetail": "Configuration details for the database associated with the application component.
" } }, "DatabaseManagementPreference": { "base": null, "refs": { "DatabasePreferences$databaseManagementPreference": "Specifies whether you're interested in self-managed databases or databases managed by AWS.
" } }, "DatabaseMigrationPreference": { "base": "Preferences for migrating a database to AWS.
", "refs": { "DatabasePreferences$databaseMigrationPreference": "Specifies your preferred migration path.
" } }, "DatabasePreferences": { "base": "Preferences on managing your databases on AWS.
", "refs": { "GetPortfolioPreferencesResponse$databasePreferences": "The transformation preferences for database applications.
", "PutPortfolioPreferencesRequest$databasePreferences": "The transformation preferences for database applications.
" } }, "GetApplicationComponentDetailsRequest": { "base": null, "refs": { } }, "GetApplicationComponentDetailsResponse": { "base": null, "refs": { } }, "GetApplicationComponentStrategiesRequest": { "base": null, "refs": { } }, "GetApplicationComponentStrategiesResponse": { "base": null, "refs": { } }, "GetAssessmentRequest": { "base": null, "refs": { } }, "GetAssessmentResponse": { "base": null, "refs": { } }, "GetImportFileTaskRequest": { "base": null, "refs": { } }, "GetImportFileTaskResponse": { "base": null, "refs": { } }, "GetPortfolioPreferencesRequest": { "base": null, "refs": { } }, "GetPortfolioPreferencesResponse": { "base": null, "refs": { } }, "GetPortfolioSummaryRequest": { "base": null, "refs": { } }, "GetPortfolioSummaryResponse": { "base": null, "refs": { } }, "GetRecommendationReportDetailsRequest": { "base": null, "refs": { } }, "GetRecommendationReportDetailsResponse": { "base": null, "refs": { } }, "GetServerDetailsRequest": { "base": null, "refs": { } }, "GetServerDetailsResponse": { "base": null, "refs": { } }, "GetServerStrategiesRequest": { "base": null, "refs": { } }, "GetServerStrategiesResponse": { "base": null, "refs": { } }, "Group": { "base": "The object containing information about distinct imports or groups for Strategy Recommendations.
", "refs": { "GroupIds$member": null } }, "GroupIds": { "base": null, "refs": { "ListApplicationComponentsRequest$groupIdFilter": "The group ID specified in to filter on.
", "ListServersRequest$groupIdFilter": "Specifies the group ID to filter on.
", "StartImportFileTaskRequest$groupId": "Groups the resources in the import file together with a unique name. This ID can be as filter in ListApplicationComponents and ListServers.
Groups the resources in the recommendation report with a unique name.
" } }, "GroupName": { "base": null, "refs": { "Group$name": "The key of the specific import group.
" } }, "Heterogeneous": { "base": "The object containing details about heterogeneous database preferences.
", "refs": { "DatabaseMigrationPreference$heterogeneous": "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.
" } }, "HeterogeneousTargetDatabaseEngine": { "base": null, "refs": { "HeterogeneousTargetDatabaseEngines$member": null } }, "HeterogeneousTargetDatabaseEngines": { "base": null, "refs": { "Heterogeneous$targetDatabaseEngine": "The target database engine for heterogeneous database migration preference.
" } }, "Homogeneous": { "base": "The object containing details about homogeneous database preferences.
", "refs": { "DatabaseMigrationPreference$homogeneous": "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.
" } }, "HomogeneousTargetDatabaseEngine": { "base": null, "refs": { "HomogeneousTargetDatabaseEngines$member": null } }, "HomogeneousTargetDatabaseEngines": { "base": null, "refs": { "Homogeneous$targetDatabaseEngine": "The target database engine for homogeneous database migration preferences.
" } }, "IPAddress": { "base": null, "refs": { "NetworkInfo$ipAddress": "Information about the IP address of the server for which the assessment was run.
" } }, "ImportFileTaskInformation": { "base": "Information about the import file tasks you request.
", "refs": { "ListImportFileTaskInformation$member": null } }, "ImportFileTaskStatus": { "base": null, "refs": { "GetImportFileTaskResponse$status": "Status of import file task.
", "ImportFileTaskInformation$status": "Status of import file task.
" } }, "InclusionStatus": { "base": null, "refs": { "ApplicationComponentDetail$inclusionStatus": "Indicates whether the application component has been included for server recommendation or not.
", "UpdateApplicationComponentConfigRequest$inclusionStatus": "Indicates whether the application component has been included for server recommendation or not.
" } }, "Integer": { "base": null, "refs": { "AntipatternSeveritySummary$count": "Contains the count of anti-patterns.
", "ApplicationComponentSummary$count": "Contains the count of application type.
", "DataCollectionDetails$failed": "The number of failed servers in the assessment.
", "DataCollectionDetails$inProgress": " The number of servers with the assessment status IN_PROGESS.
The total number of servers in the assessment.
", "DataCollectionDetails$success": "The number of successful servers in the assessment.
", "GetImportFileTaskResponse$numberOfRecordsFailed": "The number of records that failed to be imported.
", "GetImportFileTaskResponse$numberOfRecordsSuccess": "The number of records successfully imported.
", "ImportFileTaskInformation$numberOfRecordsFailed": "The number of records that failed to be imported.
", "ImportFileTaskInformation$numberOfRecordsSuccess": "The number of records successfully imported.
", "ListImportFileTaskRequest$maxResults": "The total number of items to return. The maximum value is 100.
", "ServerStrategy$numberOfApplicationComponents": "The number of application components with this strategy recommendation running on the server.
", "ServerSummary$count": "Number of servers.
", "StrategySummary$count": "The count of recommendations per strategy.
" } }, "InterfaceName": { "base": null, "refs": { "NetworkInfo$interfaceName": "Information about the name of the interface of the server for which the assessment was run.
" } }, "InternalServerException": { "base": "The server experienced an internal error. Try again.
", "refs": { } }, "ListAntipatternSeveritySummary": { "base": null, "refs": { "ApplicationComponentDetail$listAntipatternSeveritySummary": "A list of anti-pattern severity summaries.
", "AssessmentSummary$listAntipatternSeveritySummary": "List of AntipatternSeveritySummary.
", "ServerDetail$listAntipatternSeveritySummary": "A list of anti-pattern severity summaries.
" } }, "ListApplicationComponentSummary": { "base": null, "refs": { "AssessmentSummary$listApplicationComponentSummary": "List of ApplicationComponentSummary.
" } }, "ListApplicationComponentsRequest": { "base": null, "refs": { } }, "ListApplicationComponentsRequestFilterValueString": { "base": null, "refs": { "ListApplicationComponentsRequest$filterValue": " 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.
Lists information about the files you import.
" } }, "ListImportFileTaskRequest": { "base": null, "refs": { } }, "ListImportFileTaskResponse": { "base": null, "refs": { } }, "ListServerSummary": { "base": null, "refs": { "AssessmentSummary$listServerSummary": "List of ServerSummary.
" } }, "ListServersRequest": { "base": null, "refs": { } }, "ListServersResponse": { "base": null, "refs": { } }, "ListStrategySummary": { "base": null, "refs": { "AssessmentSummary$listApplicationComponentStrategySummary": "List of ApplicationComponentStrategySummary.
", "AssessmentSummary$listServerStrategySummary": "List of ServerStrategySummary.
", "ServerDetail$applicationComponentStrategySummary": "A list of strategy summaries.
" } }, "Location": { "base": null, "refs": { "SourceCode$location": "The repository name for the source code.
" } }, "MacAddress": { "base": null, "refs": { "NetworkInfo$macAddress": "Information about the MAC address of the server for which the assessment was run.
" } }, "ManagementPreference": { "base": "Preferences for migrating an application to AWS.
", "refs": { "ApplicationPreferences$managementPreference": "Application preferences that you specify to prefer managed environment.
" } }, "MaxResult": { "base": null, "refs": { "GetServerDetailsRequest$maxResults": "The maximum number of items to include in the response. The maximum value is 100.
", "ListApplicationComponentsRequest$maxResults": "The maximum number of items to include in the response. The maximum value is 100.
", "ListCollectorsRequest$maxResults": "The maximum number of items to include in the response. The maximum value is 100.
", "ListServersRequest$maxResults": "The maximum number of items to include in the response. The maximum value is 100.
" } }, "NetMask": { "base": null, "refs": { "NetworkInfo$netMask": "Information about the subnet mask of the server for which the assessment was run.
" } }, "NetworkInfo": { "base": "Information about the server's network for which the assessment was run.
", "refs": { "NetworkInfoList$member": null } }, "NetworkInfoList": { "base": null, "refs": { "SystemInfo$networkInfoList": "Networking information related to a server.
" } }, "NextToken": { "base": null, "refs": { "GetServerDetailsRequest$nextToken": " 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.
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.
The token you use to retrieve the next set of results, or null if there are no more results.
", "ListCollectorsRequest$nextToken": " 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.
The token you use to retrieve the next set of results, or null if there are no more results.
", "ListServersRequest$nextToken": " 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.
The token you use to retrieve the next set of results, or null if there are no more results.
" } }, "NoDatabaseMigrationPreference": { "base": "The object containing details about database migration preferences, when you have no particular preference.
", "refs": { "DatabaseMigrationPreference$noPreference": "Indicated that you do not prefer heterogeneous or homogeneous.
" } }, "NoManagementPreference": { "base": "Object containing the choice of application destination that you specify.
", "refs": { "ManagementPreference$noPreference": "No specific preference.
" } }, "NoPreferenceTargetDestination": { "base": null, "refs": { "NoPreferenceTargetDestinations$member": null } }, "NoPreferenceTargetDestinations": { "base": null, "refs": { "NoManagementPreference$targetDestination": "The choice of application destination that you specify.
" } }, "OSInfo": { "base": "Information about the operating system.
", "refs": { "SystemInfo$osInfo": "Operating system corresponding to a server.
" } }, "OSType": { "base": null, "refs": { "OSInfo$type": "Information about the type of operating system.
" } }, "OSVersion": { "base": null, "refs": { "OSInfo$version": "Information about the version of operating system.
" } }, "OutputFormat": { "base": null, "refs": { "StartRecommendationReportGenerationRequest$outputFormat": "The output format for the recommendation report file. The default format is Microsoft Excel.
" } }, "PrioritizeBusinessGoals": { "base": "Rank of business goals based on priority.
", "refs": { "GetPortfolioPreferencesResponse$prioritizeBusinessGoals": "The rank of business goals based on priority.
", "PutPortfolioPreferencesRequest$prioritizeBusinessGoals": "The rank of the business goals based on priority.
" } }, "PutPortfolioPreferencesRequest": { "base": null, "refs": { } }, "PutPortfolioPreferencesResponse": { "base": null, "refs": { } }, "RecommendationReportDetails": { "base": "Contains detailed information about a recommendation report.
", "refs": { "GetRecommendationReportDetailsResponse$recommendationReportDetails": "Detailed information about the recommendation report.
" } }, "RecommendationReportStatus": { "base": null, "refs": { "RecommendationReportDetails$status": "The status of the recommendation report generation task.
" } }, "RecommendationReportStatusMessage": { "base": null, "refs": { "RecommendationReportDetails$statusMessage": "The status message for recommendation report generation.
" } }, "RecommendationReportTimeStamp": { "base": null, "refs": { "RecommendationReportDetails$completionTime": "The time that the recommendation report generation task completes.
", "RecommendationReportDetails$startTime": "The time that the recommendation report generation task starts.
" } }, "RecommendationSet": { "base": "Contains a recommendation set.
", "refs": { "ApplicationComponentDetail$recommendationSet": "The top recommendation set for the application component.
", "ApplicationComponentStrategy$recommendation": "Strategy recommendation for the application component.
", "ServerDetail$recommendationSet": "A set of recommendations.
", "ServerStrategy$recommendation": "Strategy recommendation for the server.
" } }, "RecommendationTaskId": { "base": null, "refs": { "GetRecommendationReportDetailsRequest$id": " The recommendation report generation task id returned by StartRecommendationReportGeneration.
The ID of the recommendation report generation task. See the response of StartRecommendationReportGeneration.
", "StartRecommendationReportGenerationResponse$id": "The ID of the recommendation report generation task.
" } }, "ResourceId": { "base": null, "refs": { "ApplicationComponentDetail$id": "The ID of the application component.
", "ServerDetail$id": "The server ID.
" } }, "ResourceName": { "base": null, "refs": { "ApplicationComponentDetail$name": "The name of application component.
", "ServerDetail$name": "The name of the server.
" } }, "ResourceNotFoundException": { "base": "The specified ID in the request is not found.
", "refs": { } }, "ResourceSubType": { "base": null, "refs": { "ApplicationComponentDetail$resourceSubType": "The application component subtype.
" } }, "RunTimeAssessmentStatus": { "base": null, "refs": { "ServerDetail$dataCollectionStatus": "The status of assessment for the server.
" } }, "S3Bucket": { "base": null, "refs": { "S3Object$s3Bucket": "The S3 bucket name.
" } }, "S3Key": { "base": null, "refs": { "S3Object$s3key": "The Amazon S3 key name.
" } }, "S3Keys": { "base": null, "refs": { "RecommendationReportDetails$s3Keys": "The Amazon S3 key name of the report file.
" } }, "S3Object": { "base": "Contains the S3 bucket name and the Amazon S3 key name.
", "refs": { "ApplicationComponentDetail$antipatternReportS3Object": "The S3 bucket name and the Amazon S3 key name for the anti-pattern report.
", "AssessmentSummary$antipatternReportS3Object": "The Amazon S3 object containing the anti-pattern report.
", "ServerDetail$antipatternReportS3Object": "The S3 bucket name and Amazon S3 key name for anti-pattern report.
" } }, "SecretsManagerKey": { "base": null, "refs": { "UpdateApplicationComponentConfigRequest$secretsManagerKey": "Database credentials.
" } }, "SelfManageResources": { "base": "Self-managed resources.
", "refs": { "ManagementPreference$selfManageResources": "Indicates interest in managing your own resources on AWS.
" } }, "SelfManageTargetDestination": { "base": null, "refs": { "SelfManageTargetDestinations$member": null } }, "SelfManageTargetDestinations": { "base": null, "refs": { "SelfManageResources$targetDestination": "Self-managed resources target destination.
" } }, "ServerCriteria": { "base": null, "refs": { "ListServersRequest$serverCriteria": "Criteria for filtering servers.
" } }, "ServerDetail": { "base": "Detailed information about a server.
", "refs": { "GetServerDetailsResponse$serverDetail": "Detailed information about the server.
", "ServerDetails$member": null } }, "ServerDetails": { "base": null, "refs": { "ListServersResponse$serverInfos": "The list of servers with detailed information about each server.
" } }, "ServerId": { "base": null, "refs": { "ApplicationComponentDetail$associatedServerId": "The ID of the server that the application component is running on.
", "GetServerDetailsRequest$serverId": "The ID of the server.
", "GetServerStrategiesRequest$serverId": "The ID of the server.
", "UpdateServerConfigRequest$serverId": "The ID of the server.
" } }, "ServerOsType": { "base": null, "refs": { "ServerSummary$ServerOsType": "Type of operating system for the servers.
" } }, "ServerStrategies": { "base": null, "refs": { "GetServerStrategiesResponse$serverStrategies": "A list of strategy recommendations for the server.
" } }, "ServerStrategy": { "base": "Contains information about a strategy recommendation for a server.
", "refs": { "ServerStrategies$member": null } }, "ServerSummary": { "base": "Object containing details about the servers imported by Application Discovery Service
", "refs": { "ListServerSummary$member": null } }, "ServiceLinkedRoleLockClientException": { "base": "Exception to indicate that the service-linked role (SLR) is locked.
", "refs": { } }, "ServiceQuotaExceededException": { "base": "The AWS account has reached its quota of imports. Contact AWS Support to increase the quota for this account.
", "refs": { } }, "Severity": { "base": null, "refs": { "AntipatternSeveritySummary$severity": "Contains the severity of anti-patterns.
" } }, "SortOrder": { "base": null, "refs": { "ListApplicationComponentsRequest$sort": " Specifies whether to sort by ascending (ASC) or descending (DESC) order.
Specifies whether to sort by ascending (ASC) or descending (DESC) order.
Object containing source code information that is linked to an application component.
", "refs": { "SourceCodeList$member": null } }, "SourceCodeList": { "base": null, "refs": { "UpdateApplicationComponentConfigRequest$sourceCodeList": "The list of source code configurations to update for the application component.
" } }, "SourceCodeRepositories": { "base": null, "refs": { "ApplicationComponentDetail$sourceCodeRepositories": "Details about the source code repository associated with the application component.
" } }, "SourceCodeRepository": { "base": "Object containing source code information that is linked to an application component.
", "refs": { "SourceCodeRepositories$member": null } }, "SourceVersion": { "base": null, "refs": { "SourceCode$sourceVersion": "The branch of the source code.
" } }, "SrcCodeOrDbAnalysisStatus": { "base": null, "refs": { "ApplicationComponentDetail$analysisStatus": "The status of analysis, if the application component has source code or an associated database.
" } }, "StartAssessmentRequest": { "base": null, "refs": { } }, "StartAssessmentRequestS3bucketForAnalysisDataString": { "base": null, "refs": { "StartAssessmentRequest$s3bucketForAnalysisData": " The S3 bucket used by the collectors to send analysis data to the service. The bucket name must begin with migrationhub-strategy-.
The S3 bucket where all the reports generated by the service are stored. The bucket name must begin with migrationhub-strategy-.
A descriptive name for the request.
" } }, "StartImportFileTaskRequestS3bucketForReportDataString": { "base": null, "refs": { "StartImportFileTaskRequest$s3bucketForReportData": "The S3 bucket where Strategy Recommendations uploads import results. The bucket name is required to begin with migrationhub-strategy-.
" } }, "StartImportFileTaskResponse": { "base": null, "refs": { } }, "StartRecommendationReportGenerationRequest": { "base": null, "refs": { } }, "StartRecommendationReportGenerationResponse": { "base": null, "refs": { } }, "StatusMessage": { "base": null, "refs": { "ApplicationComponentDetail$antipatternReportStatusMessage": "The status message for the anti-pattern.
", "ApplicationComponentDetail$statusMessage": "A detailed description of the analysis status and any failure message.
", "AssessmentSummary$antipatternReportStatusMessage": "The status message of the anti-pattern report.
", "ServerDetail$antipatternReportStatusMessage": "A message about the status of the anti-pattern report generation.
", "ServerDetail$statusMessage": "A message about the status of data collection, which contains detailed descriptions of any error messages.
" } }, "StopAssessmentRequest": { "base": null, "refs": { } }, "StopAssessmentResponse": { "base": null, "refs": { } }, "Strategy": { "base": null, "refs": { "RecommendationSet$strategy": "The recommended strategy.
", "StrategyOption$strategy": "Type of transformation. For example, Rehost, Replatform, and so on.
", "StrategySummary$strategy": "The name of recommended strategy.
" } }, "StrategyOption": { "base": "Information about all the available strategy options for migrating and modernizing an application component.
", "refs": { "UpdateApplicationComponentConfigRequest$strategyOption": "The preferred strategy options for the application component. Use values from the GetApplicationComponentStrategies response.
", "UpdateServerConfigRequest$strategyOption": "The preferred strategy options for the application component. See the response from GetServerStrategies.
" } }, "StrategyRecommendation": { "base": null, "refs": { "ApplicationComponentStrategy$status": "The recommendation status of a strategy for an application component.
", "ServerStrategy$status": "The recommendation status of the strategy for the server.
" } }, "StrategySummary": { "base": "Object containing the summary of the strategy recommendations.
", "refs": { "ListStrategySummary$member": null } }, "String": { "base": null, "refs": { "AccessDeniedException$message": null, "ApplicationComponentDetail$osDriver": "OS driver.
", "ApplicationComponentDetail$osVersion": "OS version.
", "AssociatedApplication$id": "ID of the application as defined in Application Discovery Service.
", "AssociatedApplication$name": "Name of the application as defined in Application Discovery Service.
", "AssociatedServerIDs$member": null, "Collector$collectorId": "The ID of the collector.
", "Collector$collectorVersion": "Current version of the collector that is running in the environment that you specify.
", "Collector$hostName": "Hostname of the server that is hosting the collector.
", "Collector$ipAddress": "IP address of the server that is hosting the collector.
", "Collector$lastActivityTimeStamp": "Time when the collector last pinged the service.
", "Collector$registeredTimeStamp": "Time when the collector registered with the service.
", "ConflictException$message": null, "DatabaseConfigDetail$secretName": "AWS Secrets Manager key that holds the credentials that you use to connect to a database.
", "GetImportFileTaskRequest$id": "The ID of the import file task. This ID is returned in the response of StartImportFileTask.
", "GetImportFileTaskResponse$id": " The import file task id returned in the response of StartImportFileTask.
The name of the import task given in StartImportFileTask.
", "GetServerDetailsResponse$nextToken": "The token you use to retrieve the next set of results, or null if there are no more results.
", "Group$value": "The value of the specific import group.
", "ImportFileTaskInformation$id": "The ID of the import file task.
", "ImportFileTaskInformation$importName": " The name of the import task given in StartImportFileTask.
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.
The token you use to retrieve the next set of results, or null if there are no more results.
", "ListServersRequest$filterValue": " 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.
The S3 bucket where the report file is located.
", "S3Keys$member": null, "ServerDetail$serverType": "The type of server.
", "ServiceQuotaExceededException$message": null, "SourceCodeRepository$branch": "The branch of the source code.
", "SourceCodeRepository$repository": "The repository name for the source code.
", "SourceCodeRepository$versionControlType": "The type of repository to use for the source code.
", "StartImportFileTaskRequest$s3key": "The Amazon S3 key name of the import file.
", "StartImportFileTaskResponse$id": "The ID for a specific import task. The ID is unique within an AWS account.
", "SystemInfo$cpuArchitecture": "CPU architecture type for the server.
", "SystemInfo$fileSystemType": "File system type for the server.
" } }, "SystemInfo": { "base": "Information about the server that hosts application components.
", "refs": { "ServerDetail$systemInfo": "System information about the server.
" } }, "TargetDatabaseEngine": { "base": null, "refs": { "TargetDatabaseEngines$member": null } }, "TargetDatabaseEngines": { "base": null, "refs": { "NoDatabaseMigrationPreference$targetDatabaseEngine": "The target database engine for database migration preference that you specify.
" } }, "TargetDestination": { "base": null, "refs": { "RecommendationSet$targetDestination": "The recommended target destination.
", "StrategyOption$targetDestination": " Destination information about where the application component can migrate to. For example, EC2, ECS, and so on.
The request was denied due to request throttling.
", "refs": { } }, "TimeStamp": { "base": null, "refs": { "ApplicationComponentDetail$lastAnalyzedTimestamp": "The timestamp of when the application component was assessed.
", "AssessmentSummary$lastAnalyzedTimestamp": "The time the assessment was performed.
", "DataCollectionDetails$completionTime": "The time the assessment completes.
", "DataCollectionDetails$startTime": "The start time of assessment.
", "GetImportFileTaskResponse$completionTime": "The time that the import task completed.
", "GetImportFileTaskResponse$startTime": "Start time of the import task.
", "ImportFileTaskInformation$completionTime": "The time that the import task completes.
", "ImportFileTaskInformation$startTime": "Start time of the import task.
", "ServerDetail$lastAnalyzedTimestamp": "The timestamp of when the server was assessed.
" } }, "TranformationToolDescription": { "base": null, "refs": { "TransformationTool$description": "Description of the tool.
" } }, "TranformationToolInstallationLink": { "base": null, "refs": { "TransformationTool$tranformationToolInstallationLink": "URL for installing the tool.
" } }, "TransformationTool": { "base": "Information of the transformation tool that can be used to migrate and modernize the application.
", "refs": { "RecommendationSet$transformationTool": "The target destination for the recommendation set.
" } }, "TransformationToolName": { "base": null, "refs": { "StrategyOption$toolName": "The name of the tool that can be used to transform an application component using this strategy.
", "TransformationTool$name": "Name of the tool.
" } }, "UpdateApplicationComponentConfigRequest": { "base": null, "refs": { } }, "UpdateApplicationComponentConfigResponse": { "base": null, "refs": { } }, "UpdateServerConfigRequest": { "base": null, "refs": { } }, "UpdateServerConfigResponse": { "base": null, "refs": { } }, "ValidationException": { "base": "The request body isn't valid.
", "refs": { } }, "VersionControl": { "base": null, "refs": { "SourceCode$versionControl": "The type of repository to use for the source code.
" } }, "errorMessage": { "base": null, "refs": { "InternalServerException$message": null, "ResourceNotFoundException$message": null, "ServiceLinkedRoleLockClientException$message": null, "ThrottlingException$message": null, "ValidationException$message": null } }, "importS3Bucket": { "base": null, "refs": { "GetImportFileTaskResponse$inputS3Bucket": "The S3 bucket where import file is located.
", "GetImportFileTaskResponse$statusReportS3Bucket": "The S3 bucket name for status report of import task.
", "ImportFileTaskInformation$inputS3Bucket": "The S3 bucket where the import file is located.
", "ImportFileTaskInformation$statusReportS3Bucket": "The S3 bucket name for status report of import task.
", "StartImportFileTaskRequest$S3Bucket": " The S3 bucket where the import file is located. The bucket name is required to begin with migrationhub-strategy-.
The Amazon S3 key name of the import file.
", "GetImportFileTaskResponse$statusReportS3Key": "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.
", "ImportFileTaskInformation$inputS3Key": "The Amazon S3 key name of the import file.
", "ImportFileTaskInformation$statusReportS3Key": "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.
" } } } }