aws-sdk
Version:
AWS SDK for JavaScript
1,240 lines • 65.8 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class MigrationHubStrategy extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: MigrationHubStrategy.Types.ClientConfiguration)
config: Config & MigrationHubStrategy.Types.ClientConfiguration;
/**
* Retrieves details about an application component.
*/
getApplicationComponentDetails(params: MigrationHubStrategy.Types.GetApplicationComponentDetailsRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.GetApplicationComponentDetailsResponse) => void): Request<MigrationHubStrategy.Types.GetApplicationComponentDetailsResponse, AWSError>;
/**
* Retrieves details about an application component.
*/
getApplicationComponentDetails(callback?: (err: AWSError, data: MigrationHubStrategy.Types.GetApplicationComponentDetailsResponse) => void): Request<MigrationHubStrategy.Types.GetApplicationComponentDetailsResponse, AWSError>;
/**
* Retrieves a list of all the recommended strategies and tools for an application component running on a server.
*/
getApplicationComponentStrategies(params: MigrationHubStrategy.Types.GetApplicationComponentStrategiesRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.GetApplicationComponentStrategiesResponse) => void): Request<MigrationHubStrategy.Types.GetApplicationComponentStrategiesResponse, AWSError>;
/**
* Retrieves a list of all the recommended strategies and tools for an application component running on a server.
*/
getApplicationComponentStrategies(callback?: (err: AWSError, data: MigrationHubStrategy.Types.GetApplicationComponentStrategiesResponse) => void): Request<MigrationHubStrategy.Types.GetApplicationComponentStrategiesResponse, AWSError>;
/**
* Retrieves the status of an on-going assessment.
*/
getAssessment(params: MigrationHubStrategy.Types.GetAssessmentRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.GetAssessmentResponse) => void): Request<MigrationHubStrategy.Types.GetAssessmentResponse, AWSError>;
/**
* Retrieves the status of an on-going assessment.
*/
getAssessment(callback?: (err: AWSError, data: MigrationHubStrategy.Types.GetAssessmentResponse) => void): Request<MigrationHubStrategy.Types.GetAssessmentResponse, AWSError>;
/**
* Retrieves the details about a specific import task.
*/
getImportFileTask(params: MigrationHubStrategy.Types.GetImportFileTaskRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.GetImportFileTaskResponse) => void): Request<MigrationHubStrategy.Types.GetImportFileTaskResponse, AWSError>;
/**
* Retrieves the details about a specific import task.
*/
getImportFileTask(callback?: (err: AWSError, data: MigrationHubStrategy.Types.GetImportFileTaskResponse) => void): Request<MigrationHubStrategy.Types.GetImportFileTaskResponse, AWSError>;
/**
* Retrieve the latest ID of a specific assessment task.
*/
getLatestAssessmentId(params: MigrationHubStrategy.Types.GetLatestAssessmentIdRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.GetLatestAssessmentIdResponse) => void): Request<MigrationHubStrategy.Types.GetLatestAssessmentIdResponse, AWSError>;
/**
* Retrieve the latest ID of a specific assessment task.
*/
getLatestAssessmentId(callback?: (err: AWSError, data: MigrationHubStrategy.Types.GetLatestAssessmentIdResponse) => void): Request<MigrationHubStrategy.Types.GetLatestAssessmentIdResponse, AWSError>;
/**
* Retrieves your migration and modernization preferences.
*/
getPortfolioPreferences(params: MigrationHubStrategy.Types.GetPortfolioPreferencesRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.GetPortfolioPreferencesResponse) => void): Request<MigrationHubStrategy.Types.GetPortfolioPreferencesResponse, AWSError>;
/**
* Retrieves your migration and modernization preferences.
*/
getPortfolioPreferences(callback?: (err: AWSError, data: MigrationHubStrategy.Types.GetPortfolioPreferencesResponse) => void): Request<MigrationHubStrategy.Types.GetPortfolioPreferencesResponse, AWSError>;
/**
* Retrieves overall summary including the number of servers to rehost and the overall number of anti-patterns.
*/
getPortfolioSummary(params: MigrationHubStrategy.Types.GetPortfolioSummaryRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.GetPortfolioSummaryResponse) => void): Request<MigrationHubStrategy.Types.GetPortfolioSummaryResponse, AWSError>;
/**
* Retrieves overall summary including the number of servers to rehost and the overall number of anti-patterns.
*/
getPortfolioSummary(callback?: (err: AWSError, data: MigrationHubStrategy.Types.GetPortfolioSummaryResponse) => void): Request<MigrationHubStrategy.Types.GetPortfolioSummaryResponse, AWSError>;
/**
* Retrieves detailed information about the specified recommendation report.
*/
getRecommendationReportDetails(params: MigrationHubStrategy.Types.GetRecommendationReportDetailsRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.GetRecommendationReportDetailsResponse) => void): Request<MigrationHubStrategy.Types.GetRecommendationReportDetailsResponse, AWSError>;
/**
* Retrieves detailed information about the specified recommendation report.
*/
getRecommendationReportDetails(callback?: (err: AWSError, data: MigrationHubStrategy.Types.GetRecommendationReportDetailsResponse) => void): Request<MigrationHubStrategy.Types.GetRecommendationReportDetailsResponse, AWSError>;
/**
* Retrieves detailed information about a specified server.
*/
getServerDetails(params: MigrationHubStrategy.Types.GetServerDetailsRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.GetServerDetailsResponse) => void): Request<MigrationHubStrategy.Types.GetServerDetailsResponse, AWSError>;
/**
* Retrieves detailed information about a specified server.
*/
getServerDetails(callback?: (err: AWSError, data: MigrationHubStrategy.Types.GetServerDetailsResponse) => void): Request<MigrationHubStrategy.Types.GetServerDetailsResponse, AWSError>;
/**
* Retrieves recommended strategies and tools for the specified server.
*/
getServerStrategies(params: MigrationHubStrategy.Types.GetServerStrategiesRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.GetServerStrategiesResponse) => void): Request<MigrationHubStrategy.Types.GetServerStrategiesResponse, AWSError>;
/**
* Retrieves recommended strategies and tools for the specified server.
*/
getServerStrategies(callback?: (err: AWSError, data: MigrationHubStrategy.Types.GetServerStrategiesResponse) => void): Request<MigrationHubStrategy.Types.GetServerStrategiesResponse, AWSError>;
/**
* Retrieves a list of all the servers fetched from customer vCenter using Strategy Recommendation Collector.
*/
listAnalyzableServers(params: MigrationHubStrategy.Types.ListAnalyzableServersRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.ListAnalyzableServersResponse) => void): Request<MigrationHubStrategy.Types.ListAnalyzableServersResponse, AWSError>;
/**
* Retrieves a list of all the servers fetched from customer vCenter using Strategy Recommendation Collector.
*/
listAnalyzableServers(callback?: (err: AWSError, data: MigrationHubStrategy.Types.ListAnalyzableServersResponse) => void): Request<MigrationHubStrategy.Types.ListAnalyzableServersResponse, AWSError>;
/**
* Retrieves a list of all the application components (processes).
*/
listApplicationComponents(params: MigrationHubStrategy.Types.ListApplicationComponentsRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.ListApplicationComponentsResponse) => void): Request<MigrationHubStrategy.Types.ListApplicationComponentsResponse, AWSError>;
/**
* Retrieves a list of all the application components (processes).
*/
listApplicationComponents(callback?: (err: AWSError, data: MigrationHubStrategy.Types.ListApplicationComponentsResponse) => void): Request<MigrationHubStrategy.Types.ListApplicationComponentsResponse, AWSError>;
/**
* Retrieves a list of all the installed collectors.
*/
listCollectors(params: MigrationHubStrategy.Types.ListCollectorsRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.ListCollectorsResponse) => void): Request<MigrationHubStrategy.Types.ListCollectorsResponse, AWSError>;
/**
* Retrieves a list of all the installed collectors.
*/
listCollectors(callback?: (err: AWSError, data: MigrationHubStrategy.Types.ListCollectorsResponse) => void): Request<MigrationHubStrategy.Types.ListCollectorsResponse, AWSError>;
/**
* Retrieves a list of all the imports performed.
*/
listImportFileTask(params: MigrationHubStrategy.Types.ListImportFileTaskRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.ListImportFileTaskResponse) => void): Request<MigrationHubStrategy.Types.ListImportFileTaskResponse, AWSError>;
/**
* Retrieves a list of all the imports performed.
*/
listImportFileTask(callback?: (err: AWSError, data: MigrationHubStrategy.Types.ListImportFileTaskResponse) => void): Request<MigrationHubStrategy.Types.ListImportFileTaskResponse, AWSError>;
/**
* Returns a list of all the servers.
*/
listServers(params: MigrationHubStrategy.Types.ListServersRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.ListServersResponse) => void): Request<MigrationHubStrategy.Types.ListServersResponse, AWSError>;
/**
* Returns a list of all the servers.
*/
listServers(callback?: (err: AWSError, data: MigrationHubStrategy.Types.ListServersResponse) => void): Request<MigrationHubStrategy.Types.ListServersResponse, AWSError>;
/**
* Saves the specified migration and modernization preferences.
*/
putPortfolioPreferences(params: MigrationHubStrategy.Types.PutPortfolioPreferencesRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.PutPortfolioPreferencesResponse) => void): Request<MigrationHubStrategy.Types.PutPortfolioPreferencesResponse, AWSError>;
/**
* Saves the specified migration and modernization preferences.
*/
putPortfolioPreferences(callback?: (err: AWSError, data: MigrationHubStrategy.Types.PutPortfolioPreferencesResponse) => void): Request<MigrationHubStrategy.Types.PutPortfolioPreferencesResponse, AWSError>;
/**
* Starts the assessment of an on-premises environment.
*/
startAssessment(params: MigrationHubStrategy.Types.StartAssessmentRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.StartAssessmentResponse) => void): Request<MigrationHubStrategy.Types.StartAssessmentResponse, AWSError>;
/**
* Starts the assessment of an on-premises environment.
*/
startAssessment(callback?: (err: AWSError, data: MigrationHubStrategy.Types.StartAssessmentResponse) => void): Request<MigrationHubStrategy.Types.StartAssessmentResponse, AWSError>;
/**
* Starts a file import.
*/
startImportFileTask(params: MigrationHubStrategy.Types.StartImportFileTaskRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.StartImportFileTaskResponse) => void): Request<MigrationHubStrategy.Types.StartImportFileTaskResponse, AWSError>;
/**
* Starts a file import.
*/
startImportFileTask(callback?: (err: AWSError, data: MigrationHubStrategy.Types.StartImportFileTaskResponse) => void): Request<MigrationHubStrategy.Types.StartImportFileTaskResponse, AWSError>;
/**
* Starts generating a recommendation report.
*/
startRecommendationReportGeneration(params: MigrationHubStrategy.Types.StartRecommendationReportGenerationRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.StartRecommendationReportGenerationResponse) => void): Request<MigrationHubStrategy.Types.StartRecommendationReportGenerationResponse, AWSError>;
/**
* Starts generating a recommendation report.
*/
startRecommendationReportGeneration(callback?: (err: AWSError, data: MigrationHubStrategy.Types.StartRecommendationReportGenerationResponse) => void): Request<MigrationHubStrategy.Types.StartRecommendationReportGenerationResponse, AWSError>;
/**
* Stops the assessment of an on-premises environment.
*/
stopAssessment(params: MigrationHubStrategy.Types.StopAssessmentRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.StopAssessmentResponse) => void): Request<MigrationHubStrategy.Types.StopAssessmentResponse, AWSError>;
/**
* Stops the assessment of an on-premises environment.
*/
stopAssessment(callback?: (err: AWSError, data: MigrationHubStrategy.Types.StopAssessmentResponse) => void): Request<MigrationHubStrategy.Types.StopAssessmentResponse, AWSError>;
/**
* Updates the configuration of an application component.
*/
updateApplicationComponentConfig(params: MigrationHubStrategy.Types.UpdateApplicationComponentConfigRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.UpdateApplicationComponentConfigResponse) => void): Request<MigrationHubStrategy.Types.UpdateApplicationComponentConfigResponse, AWSError>;
/**
* Updates the configuration of an application component.
*/
updateApplicationComponentConfig(callback?: (err: AWSError, data: MigrationHubStrategy.Types.UpdateApplicationComponentConfigResponse) => void): Request<MigrationHubStrategy.Types.UpdateApplicationComponentConfigResponse, AWSError>;
/**
* Updates the configuration of the specified server.
*/
updateServerConfig(params: MigrationHubStrategy.Types.UpdateServerConfigRequest, callback?: (err: AWSError, data: MigrationHubStrategy.Types.UpdateServerConfigResponse) => void): Request<MigrationHubStrategy.Types.UpdateServerConfigResponse, AWSError>;
/**
* Updates the configuration of the specified server.
*/
updateServerConfig(callback?: (err: AWSError, data: MigrationHubStrategy.Types.UpdateServerConfigResponse) => void): Request<MigrationHubStrategy.Types.UpdateServerConfigResponse, AWSError>;
}
declare namespace MigrationHubStrategy {
export interface AnalysisStatusUnion {
/**
* The status of the analysis.
*/
runtimeAnalysisStatus?: RuntimeAnalysisStatus;
/**
* The status of the source code or database analysis.
*/
srcCodeOrDbAnalysisStatus?: SrcCodeOrDbAnalysisStatus;
}
export type AnalysisType = "SOURCE_CODE_ANALYSIS"|"DATABASE_ANALYSIS"|"RUNTIME_ANALYSIS"|"BINARY_ANALYSIS"|string;
export interface AnalyzableServerSummary {
/**
* The host name of the analyzable server.
*/
hostname?: String;
/**
* The ip address of the analyzable server.
*/
ipAddress?: String;
/**
* The data source of the analyzable server.
*/
source?: String;
/**
* The virtual machine id of the analyzable server.
*/
vmId?: String;
}
export type AnalyzableServerSummaryList = AnalyzableServerSummary[];
export interface AnalyzerNameUnion {
/**
* The binary analyzer names.
*/
binaryAnalyzerName?: BinaryAnalyzerName;
/**
* The assessment analyzer names.
*/
runTimeAnalyzerName?: RunTimeAnalyzerName;
/**
* The source code analyzer names.
*/
sourceCodeAnalyzerName?: SourceCodeAnalyzerName;
}
export interface AntipatternReportResult {
/**
* The analyzer name.
*/
analyzerName?: AnalyzerNameUnion;
antiPatternReportS3Object?: S3Object;
/**
* The status of the anti-pattern report generation.
*/
antipatternReportStatus?: AntipatternReportStatus;
/**
* The status message for the anti-pattern.
*/
antipatternReportStatusMessage?: StatusMessage;
}
export type AntipatternReportResultList = AntipatternReportResult[];
export type AntipatternReportStatus = "FAILED"|"IN_PROGRESS"|"SUCCESS"|string;
export interface AntipatternSeveritySummary {
/**
* Contains the count of anti-patterns.
*/
count?: Integer;
/**
* Contains the severity of anti-patterns.
*/
severity?: Severity;
}
export type 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"|string;
export interface AppUnitError {
/**
* The category of the error.
*/
appUnitErrorCategory?: AppUnitErrorCategory;
}
export type AppUnitErrorCategory = "CREDENTIAL_ERROR"|"CONNECTIVITY_ERROR"|"PERMISSION_ERROR"|"UNSUPPORTED_ERROR"|"OTHER_ERROR"|string;
export type ApplicationComponentCriteria = "NOT_DEFINED"|"APP_NAME"|"SERVER_ID"|"APP_TYPE"|"STRATEGY"|"DESTINATION"|"ANALYSIS_STATUS"|"ERROR_CATEGORY"|string;
export interface ApplicationComponentDetail {
/**
* The status of analysis, if the application component has source code or an associated database.
*/
analysisStatus?: SrcCodeOrDbAnalysisStatus;
/**
* The S3 bucket name and the Amazon S3 key name for the anti-pattern report.
*/
antipatternReportS3Object?: S3Object;
/**
* The status of the anti-pattern report generation.
*/
antipatternReportStatus?: AntipatternReportStatus;
/**
* The status message for the anti-pattern.
*/
antipatternReportStatusMessage?: StatusMessage;
/**
* The type of application component.
*/
appType?: AppType;
/**
* The error in the analysis of the source code or database.
*/
appUnitError?: AppUnitError;
/**
* The ID of the server that the application component is running on.
*/
associatedServerId?: ServerId;
/**
* Configuration details for the database associated with the application component.
*/
databaseConfigDetail?: DatabaseConfigDetail;
/**
* The ID of the application component.
*/
id?: ResourceId;
/**
* Indicates whether the application component has been included for server recommendation or not.
*/
inclusionStatus?: InclusionStatus;
/**
* The timestamp of when the application component was assessed.
*/
lastAnalyzedTimestamp?: TimeStamp;
/**
* A list of anti-pattern severity summaries.
*/
listAntipatternSeveritySummary?: ListAntipatternSeveritySummary;
/**
* Set to true if the application component is running on multiple servers.
*/
moreServerAssociationExists?: Boolean;
/**
* The name of application component.
*/
name?: ResourceName;
/**
* OS driver.
*/
osDriver?: String;
/**
* OS version.
*/
osVersion?: String;
/**
* The top recommendation set for the application component.
*/
recommendationSet?: RecommendationSet;
/**
* The application component subtype.
*/
resourceSubType?: ResourceSubType;
/**
* A list of the analysis results.
*/
resultList?: ResultList;
/**
* The status of the application unit.
*/
runtimeStatus?: RuntimeAnalysisStatus;
/**
* The status message for the application unit.
*/
runtimeStatusMessage?: StatusMessage;
/**
* Details about the source code repository associated with the application component.
*/
sourceCodeRepositories?: SourceCodeRepositories;
/**
* A detailed description of the analysis status and any failure message.
*/
statusMessage?: StatusMessage;
}
export type ApplicationComponentDetails = ApplicationComponentDetail[];
export type ApplicationComponentId = string;
export interface ApplicationComponentStatusSummary {
/**
* The number of application components successfully analyzed, partially successful or failed analysis.
*/
count?: Integer;
/**
* The status of database analysis.
*/
srcCodeOrDbAnalysisStatus?: SrcCodeOrDbAnalysisStatus;
}
export type ApplicationComponentStrategies = ApplicationComponentStrategy[];
export interface ApplicationComponentStrategy {
/**
* Set to true if the recommendation is set as preferred.
*/
isPreferred?: Boolean;
/**
* Strategy recommendation for the application component.
*/
recommendation?: RecommendationSet;
/**
* The recommendation status of a strategy for an application component.
*/
status?: StrategyRecommendation;
}
export interface ApplicationComponentSummary {
/**
* Contains the name of application types.
*/
appType?: AppType;
/**
* Contains the count of application type.
*/
count?: Integer;
}
export type ApplicationMode = "ALL"|"KNOWN"|"UNKNOWN"|string;
export interface ApplicationPreferences {
/**
* Application preferences that you specify to prefer managed environment.
*/
managementPreference?: ManagementPreference;
}
export type AssessmentDataSourceType = "StrategyRecommendationsApplicationDataCollector"|"ManualImport"|"ApplicationDiscoveryService"|string;
export type AssessmentStatus = "IN_PROGRESS"|"COMPLETE"|"FAILED"|"STOPPED"|string;
export type AssessmentStatusMessage = string;
export interface AssessmentSummary {
/**
* The Amazon S3 object containing the anti-pattern report.
*/
antipatternReportS3Object?: S3Object;
/**
* The status of the anti-pattern report.
*/
antipatternReportStatus?: AntipatternReportStatus;
/**
* The status message of the anti-pattern report.
*/
antipatternReportStatusMessage?: StatusMessage;
/**
* The time the assessment was performed.
*/
lastAnalyzedTimestamp?: TimeStamp;
/**
* List of AntipatternSeveritySummary.
*/
listAntipatternSeveritySummary?: ListAntipatternSeveritySummary;
/**
* List of status summaries of the analyzed application components.
*/
listApplicationComponentStatusSummary?: ListApplicationComponentStatusSummary;
/**
* List of ApplicationComponentStrategySummary.
*/
listApplicationComponentStrategySummary?: ListStrategySummary;
/**
* List of ApplicationComponentSummary.
*/
listApplicationComponentSummary?: ListApplicationComponentSummary;
/**
* List of status summaries of the analyzed servers.
*/
listServerStatusSummary?: ListServerStatusSummary;
/**
* List of ServerStrategySummary.
*/
listServerStrategySummary?: ListStrategySummary;
/**
* List of ServerSummary.
*/
listServerSummary?: ListServerSummary;
}
export interface AssessmentTarget {
/**
* Condition of an assessment.
*/
condition: Condition;
/**
* Name of an assessment.
*/
name: String;
/**
* Values of an assessment.
*/
values: AssessmentTargetValues;
}
export type AssessmentTargetValues = String[];
export type AssessmentTargets = AssessmentTarget[];
export interface AssociatedApplication {
/**
* ID of the application as defined in Application Discovery Service.
*/
id?: String;
/**
* Name of the application as defined in Application Discovery Service.
*/
name?: String;
}
export type AssociatedApplications = AssociatedApplication[];
export type AssociatedServerIDs = String[];
export type AsyncTaskId = string;
export type AuthType = "NTLM"|"SSH"|"CERT"|string;
export interface AwsManagedResources {
/**
* The choice of application destination that you specify.
*/
targetDestination: AwsManagedTargetDestinations;
}
export type AwsManagedTargetDestination = "None specified"|"AWS Elastic BeanStalk"|"AWS Fargate"|string;
export type AwsManagedTargetDestinations = AwsManagedTargetDestination[];
export type BinaryAnalyzerName = "DLL_ANALYZER"|"BYTECODE_ANALYZER"|string;
export type Boolean = boolean;
export interface BusinessGoals {
/**
* Business goal to reduce license costs.
*/
licenseCostReduction?: BusinessGoalsInteger;
/**
* Business goal to modernize infrastructure by moving to cloud native technologies.
*/
modernizeInfrastructureWithCloudNativeTechnologies?: BusinessGoalsInteger;
/**
* Business goal to reduce the operational overhead on the team by moving into managed services.
*/
reduceOperationalOverheadWithManagedServices?: BusinessGoalsInteger;
/**
* Business goal to achieve migration at a fast pace.
*/
speedOfMigration?: BusinessGoalsInteger;
}
export type BusinessGoalsInteger = number;
export interface Collector {
/**
* Indicates the health of a collector.
*/
collectorHealth?: CollectorHealth;
/**
* The ID of the collector.
*/
collectorId?: String;
/**
* Current version of the collector that is running in the environment that you specify.
*/
collectorVersion?: String;
/**
* Summary of the collector configuration.
*/
configurationSummary?: ConfigurationSummary;
/**
* Hostname of the server that is hosting the collector.
*/
hostName?: String;
/**
* IP address of the server that is hosting the collector.
*/
ipAddress?: String;
/**
* Time when the collector last pinged the service.
*/
lastActivityTimeStamp?: String;
/**
* Time when the collector registered with the service.
*/
registeredTimeStamp?: String;
}
export type CollectorHealth = "COLLECTOR_HEALTHY"|"COLLECTOR_UNHEALTHY"|string;
export type Collectors = Collector[];
export type Condition = "EQUALS"|"NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"|string;
export interface ConfigurationSummary {
/**
* IP address based configurations.
*/
ipAddressBasedRemoteInfoList?: IPAddressBasedRemoteInfoList;
/**
* The list of pipeline info configurations.
*/
pipelineInfoList?: PipelineInfoList;
/**
* Info about the remote server source code configuration.
*/
remoteSourceCodeAnalysisServerInfo?: RemoteSourceCodeAnalysisServerInfo;
/**
* The list of vCenter configurations.
*/
vcenterBasedRemoteInfoList?: VcenterBasedRemoteInfoList;
/**
* The list of the version control configurations.
*/
versionControlInfoList?: VersionControlInfoList;
}
export interface DataCollectionDetails {
/**
* The time the assessment completes.
*/
completionTime?: TimeStamp;
/**
* The number of failed servers in the assessment.
*/
failed?: Integer;
/**
* The number of servers with the assessment status IN_PROGESS.
*/
inProgress?: Integer;
/**
* The total number of servers in the assessment.
*/
servers?: Integer;
/**
* The start time of assessment.
*/
startTime?: TimeStamp;
/**
* The status of the assessment.
*/
status?: AssessmentStatus;
/**
* The status message of the assessment.
*/
statusMessage?: AssessmentStatusMessage;
/**
* The number of successful servers in the assessment.
*/
success?: Integer;
}
export type DataSourceType = "ApplicationDiscoveryService"|"MPA"|"Import"|"StrategyRecommendationsApplicationDataCollector"|string;
export interface DatabaseConfigDetail {
/**
* AWS Secrets Manager key that holds the credentials that you use to connect to a database.
*/
secretName?: String;
}
export type DatabaseManagementPreference = "AWS-managed"|"Self-manage"|"No preference"|string;
export interface DatabaseMigrationPreference {
/**
* 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.
*/
heterogeneous?: Heterogeneous;
/**
* 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.
*/
homogeneous?: Homogeneous;
/**
* Indicated that you do not prefer heterogeneous or homogeneous.
*/
noPreference?: NoDatabaseMigrationPreference;
}
export interface DatabasePreferences {
/**
* Specifies whether you're interested in self-managed databases or databases managed by AWS.
*/
databaseManagementPreference?: DatabaseManagementPreference;
/**
* Specifies your preferred migration path.
*/
databaseMigrationPreference?: DatabaseMigrationPreference;
}
export interface GetApplicationComponentDetailsRequest {
/**
* The ID of the application component. The ID is unique within an AWS account.
*/
applicationComponentId: ApplicationComponentId;
}
export interface GetApplicationComponentDetailsResponse {
/**
* Detailed information about an application component.
*/
applicationComponentDetail?: ApplicationComponentDetail;
/**
* The associated application group as defined in AWS Application Discovery Service.
*/
associatedApplications?: AssociatedApplications;
/**
* A list of the IDs of the servers on which the application component is running.
*/
associatedServerIds?: AssociatedServerIDs;
/**
* Set to true if the application component belongs to more than one application group.
*/
moreApplicationResource?: Boolean;
}
export interface GetApplicationComponentStrategiesRequest {
/**
* The ID of the application component. The ID is unique within an AWS account.
*/
applicationComponentId: ApplicationComponentId;
}
export interface GetApplicationComponentStrategiesResponse {
/**
* A list of application component strategy recommendations.
*/
applicationComponentStrategies?: ApplicationComponentStrategies;
}
export interface GetAssessmentRequest {
/**
* The assessmentid returned by StartAssessment.
*/
id: AsyncTaskId;
}
export interface GetAssessmentResponse {
/**
* List of criteria for assessment.
*/
assessmentTargets?: AssessmentTargets;
/**
* Detailed information about the assessment.
*/
dataCollectionDetails?: DataCollectionDetails;
/**
* The ID for the specific assessment task.
*/
id?: AsyncTaskId;
}
export interface GetImportFileTaskRequest {
/**
* The ID of the import file task. This ID is returned in the response of StartImportFileTask.
*/
id: String;
}
export interface GetImportFileTaskResponse {
/**
* The time that the import task completed.
*/
completionTime?: TimeStamp;
/**
* The import file task id returned in the response of StartImportFileTask.
*/
id?: String;
/**
* The name of the import task given in StartImportFileTask.
*/
importName?: String;
/**
* The S3 bucket where import file is located.
*/
inputS3Bucket?: importS3Bucket;
/**
* The Amazon S3 key name of the import file.
*/
inputS3Key?: importS3Key;
/**
* The number of records that failed to be imported.
*/
numberOfRecordsFailed?: Integer;
/**
* The number of records successfully imported.
*/
numberOfRecordsSuccess?: Integer;
/**
* Start time of the import task.
*/
startTime?: TimeStamp;
/**
* Status of import file task.
*/
status?: ImportFileTaskStatus;
/**
* The S3 bucket name for status report of import task.
*/
statusReportS3Bucket?: importS3Bucket;
/**
* 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.
*/
statusReportS3Key?: importS3Key;
}
export interface GetLatestAssessmentIdRequest {
}
export interface GetLatestAssessmentIdResponse {
/**
* The latest ID for the specific assessment task.
*/
id?: AsyncTaskId;
}
export interface GetPortfolioPreferencesRequest {
}
export interface GetPortfolioPreferencesResponse {
/**
* The classification for application component types.
*/
applicationMode?: ApplicationMode;
/**
* The transformation preferences for non-database applications.
*/
applicationPreferences?: ApplicationPreferences;
/**
* The transformation preferences for database applications.
*/
databasePreferences?: DatabasePreferences;
/**
* The rank of business goals based on priority.
*/
prioritizeBusinessGoals?: PrioritizeBusinessGoals;
}
export interface GetPortfolioSummaryRequest {
}
export interface GetPortfolioSummaryResponse {
/**
* An assessment summary for the portfolio including the number of servers to rehost and the overall number of anti-patterns.
*/
assessmentSummary?: AssessmentSummary;
}
export interface GetRecommendationReportDetailsRequest {
/**
* The recommendation report generation task id returned by StartRecommendationReportGeneration.
*/
id: RecommendationTaskId;
}
export interface GetRecommendationReportDetailsResponse {
/**
* The ID of the recommendation report generation task. See the response of StartRecommendationReportGeneration.
*/
id?: RecommendationTaskId;
/**
* Detailed information about the recommendation report.
*/
recommendationReportDetails?: RecommendationReportDetails;
}
export interface GetServerDetailsRequest {
/**
* The maximum number of items to include in the response. The maximum value is 100.
*/
maxResults?: MaxResult;
/**
* 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.
*/
nextToken?: NextToken;
/**
* The ID of the server.
*/
serverId: ServerId;
}
export interface GetServerDetailsResponse {
/**
* The associated application group the server belongs to, as defined in AWS Application Discovery Service.
*/
associatedApplications?: AssociatedApplications;
/**
* The token you use to retrieve the next set of results, or null if there are no more results.
*/
nextToken?: String;
/**
* Detailed information about the server.
*/
serverDetail?: ServerDetail;
}
export interface GetServerStrategiesRequest {
/**
* The ID of the server.
*/
serverId: ServerId;
}
export interface GetServerStrategiesResponse {
/**
* A list of strategy recommendations for the server.
*/
serverStrategies?: ServerStrategies;
}
export interface Group {
/**
* The key of the specific import group.
*/
name?: GroupName;
/**
* The value of the specific import group.
*/
value?: String;
}
export type GroupIds = Group[];
export type GroupName = "ExternalId"|"ExternalSourceType"|string;
export interface Heterogeneous {
/**
* The target database engine for heterogeneous database migration preference.
*/
targetDatabaseEngine: HeterogeneousTargetDatabaseEngines;
}
export type HeterogeneousTargetDatabaseEngine = "None specified"|"Amazon Aurora"|"AWS PostgreSQL"|"MySQL"|"Microsoft SQL Server"|"Oracle Database"|"MariaDB"|"SAP"|"Db2 LUW"|"MongoDB"|string;
export type HeterogeneousTargetDatabaseEngines = HeterogeneousTargetDatabaseEngine[];
export interface Homogeneous {
/**
* The target database engine for homogeneous database migration preferences.
*/
targetDatabaseEngine?: HomogeneousTargetDatabaseEngines;
}
export type HomogeneousTargetDatabaseEngine = "None specified"|string;
export type HomogeneousTargetDatabaseEngines = HomogeneousTargetDatabaseEngine[];
export type IPAddress = string;
export interface IPAddressBasedRemoteInfo {
/**
* The type of authorization.
*/
authType?: AuthType;
/**
* The time stamp of the configuration.
*/
ipAddressConfigurationTimeStamp?: String;
/**
* The type of the operating system.
*/
osType?: OSType;
}
export type IPAddressBasedRemoteInfoList = IPAddressBasedRemoteInfo[];
export interface ImportFileTaskInformation {
/**
* The time that the import task completes.
*/
completionTime?: TimeStamp;
/**
* The ID of the import file task.
*/
id?: String;
/**
* The name of the import task given in StartImportFileTask.
*/
importName?: String;
/**
* The S3 bucket where the import file is located.
*/
inputS3Bucket?: importS3Bucket;
/**
* The Amazon S3 key name of the import file.
*/
inputS3Key?: importS3Key;
/**
* The number of records that failed to be imported.
*/
numberOfRecordsFailed?: Integer;
/**
* The number of records successfully imported.
*/
numberOfRecordsSuccess?: Integer;
/**
* Start time of the import task.
*/
startTime?: TimeStamp;
/**
* Status of import file task.
*/
status?: ImportFileTaskStatus;
/**
* The S3 bucket name for status report of import task.
*/
statusReportS3Bucket?: importS3Bucket;
/**
* 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.
*/
statusReportS3Key?: importS3Key;
}
export type ImportFileTaskStatus = "ImportInProgress"|"ImportFailed"|"ImportPartialSuccess"|"ImportSuccess"|"DeleteInProgress"|"DeleteFailed"|"DeletePartialSuccess"|"DeleteSuccess"|string;
export type InclusionStatus = "excludeFromAssessment"|"includeInAssessment"|string;
export type Integer = number;
export type InterfaceName = string;
export interface ListAnalyzableServersRequest {
/**
* The maximum number of items to include in the response. The maximum value is 100.
*/
maxResults?: MaxResult;
/**
* 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.
*/
nextToken?: NextToken;
/**
* Specifies whether to sort by ascending (ASC) or descending (DESC) order.
*/
sort?: SortOrder;
}
export interface ListAnalyzableServersResponse {
/**
* The list of analyzable servers with summary information about each server.
*/
analyzableServers?: AnalyzableServerSummaryList;
/**
* The token you use to retrieve the next set of results, or null if there are no more results.
*/
nextToken?: NextToken;
}
export type ListAntipatternSeveritySummary = AntipatternSeveritySummary[];
export type ListApplicationComponentStatusSummary = ApplicationComponentStatusSummary[];
export type ListApplicationComponentSummary = ApplicationComponentSummary[];
export interface ListApplicationComponentsRequest {
/**
* Criteria for filtering the list of application components.
*/
applicationComponentCriteria?: ApplicationComponentCriteria;
/**
* 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.
*/
filterValue?: ListApplicationComponentsRequestFilterValueString;
/**
* The group ID specified in to filter on.
*/
groupIdFilter?: GroupIds;
/**
* The maximum number of items to include in the response. The maximum value is 100.
*/
maxResults?: MaxResult;
/**
* 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.
*/
nextToken?: NextToken;
/**
* Specifies whether to sort by ascending (ASC) or descending (DESC) order.
*/
sort?: SortOrder;
}
export type ListApplicationComponentsRequestFilterValueString = string;
export interface ListApplicationComponentsResponse {
/**
* The list of application components with detailed information about each component.
*/
applicationComponentInfos?: ApplicationComponentDetails;
/**
* The token you use to retrieve the next set of results, or null if there are no more results.
*/
nextToken?: NextToken;
}
export interface ListCollectorsRequest {
/**
* The maximum number of items to include in the response. The maximum value is 100.
*/
maxResults?: MaxResult;
/**
* 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.
*/
nextToken?: NextToken;
}
export interface ListCollectorsResponse {
/**
* The list of all the installed collectors.
*/
Collectors?: Collectors;
/**
* The token you use to retrieve the next set of results, or null if there are no more results.
*/
nextToken?: NextToken;
}
export type ListImportFileTaskInformation = ImportFileTaskInformation[];
export interface ListImportFileTaskRequest {
/**
* The total number of items to return. The maximum value is 100.
*/
maxResults?: Integer;
/**
* 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.
*/
nextToken?: String;
}
export interface ListImportFileTaskResponse {
/**
* The token you use to retrieve the next set of results, or null if there are no more results.
*/
nextToken?: String;
/**
* Lists information about the files you import.
*/
taskInfos?: ListImportFileTaskInformation;
}
export type ListServerStatusSummary = ServerStatusSummary[];
export type ListServerSummary = ServerSummary[];
export interface ListServersRequest {
/**
* 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.
*/
filterValue?: String;
/**
* Specifies the group ID to filter on.
*/
groupIdFilter?: GroupIds;
/**
* The maximum number of items to include in the response. The maximum value is 100.
*/
maxResults?: MaxResult;
/**
* 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.
*/
nextToken?: NextToken;
/**
* Criteria for filtering servers.
*/
serverCriteria?: ServerCriteria;
/**
* Specifies whether to sort by ascending (ASC) or descending (DESC) order.
*/
sort?: SortOrder;
}
export interface ListServersResponse {
/**
* The token you use to retrieve the next set of results, or null if there are no more results.
*/
nextToken?: NextToken;
/**
* The list of servers with detailed information about each server.
*/
serverInfos?: ServerDetails;
}
export type ListStrategySummary = StrategySummary[];
export type Location = string;
export type MacAddress = string;
export interface ManagementPreference {
/**
* Indicates interest in solutions that are managed by AWS.
*/
awsManagedResources?: AwsManagedResources;
/**
* No specific preference.
*/
noPreference?: NoManagementPreference;
/**
* Indicates interest in managing your own resources on AWS.
*/
selfManageResources?: SelfManageResources;
}
export type MaxResult = number;
export type NetMask = string;
export interface NetworkInfo {
/**
* Information about the name of the interface of the server for which the assessment was run.
*/
interfaceName: InterfaceName;
/**
* Information about the IP address of the server for which the assessment was run.
*/
ipAddress: IPAddress;
/**
* Information about the MAC address of the server for which the assessment was run.
*/
macAddress: MacAddress;
/**
* Information about the subnet mask of the server for which the assessment was run.
*/
netMask: NetMask;
}
export type NetworkInfoList = NetworkInfo[];
export type NextToken = string;
export interface NoDatabaseMigrationPreference {
/**
* The target database engine for database migration preference that you specify.
*/
targetDatabaseEngine: TargetDatabaseEngines;
}
export interface NoManagementPreference {
/**
* The choice of application destination that you specify.
*/
targetDestination: NoPreferenceTargetDestinations;
}
export type NoPreferenceTargetDestination = "None specified"|"AWS Elastic BeanStalk"|"AWS Fargate"|"Amazon Elastic Cloud Compute (EC2)"|"Amazon Elastic Container Service (ECS)"|"Amazon Elastic Kubernetes Service (EKS)"|string;
export type NoPreferenceTargetDestinations = NoPreferenceTargetDestination[];
export interface OSInfo {
/**
* Information about the type of operating system.
*/
type?: OSType;
/**
* Information about the version of operating system.
*/
version?: OSVersion;
}
export type OSType = "LINUX"|"WINDOWS"|string;
export type OSVersion = string;
export type OutputFormat = "Excel"|"Json"|string;
export interface PipelineInfo {
/**
* The time when the pipeline info was configured.
*/
pipelineConfigurationTimeStamp?: String;
/**
* The type of pipeline.
*/
pipelineType?: PipelineType;
}
export type PipelineInfoList = PipelineInfo[];
export type PipelineType = "AZURE_DEVOPS"|string;
export interface PrioritizeBusinessGoals {
/**
* Rank of business goals based on priority.
*/
businessGoals?: BusinessGoals;
}
export type ProjectName = string;
export interface PutPortfolioPreferencesRequest {
/**
* The classification for application component types.
*/
applicationMode?: ApplicationMode;
/**
* The transformation preferences for non-database applications.
*/
applicationPreferences?: ApplicationPreferences;
/**
* The transformation preferences for database applications.
*/
databasePreferences?: DatabasePreferences;
/**
* The rank of the business goals based on priority.
*/
prioritizeBusinessGoals?: PrioritizeBusinessGoals;
}
export interface PutPortfolioPreferencesResponse {
}
export interface RecommendationReportDetails {
/**
* The time that the recommendation report generation task completes.
*/
completionTime?: RecommendationReportTimeStamp;
/**
* The S3 bucket where the report file is located.
*/
s3Bucket?: String;
/**
* The Amazon S3 key name of the report file.
*/
s3Keys?: S3Keys;
/**
* The time that the recommendation report generation task starts.
*/
startTime?: RecommendationReportTimeStamp;
/**
* The status of the recommendation report generation task.
*/
status?: RecommendationReportStatus;
/**
* The status message for recommendation report generation.
*/
statusMessage?: RecommendationReportStatusMessage;
}
export type RecommendationReportStatus = "FAILED"|"IN_PROGRESS"|"SUCCESS"|string;
export type RecommendationReportStatusMessage = string;
export type RecommendationReportTimeStamp = Date;
export interface RecommendationSet {
/**
* The recommended strategy.
*/
strategy?: Strategy;
/**
* The recommended target destination.
*/
targetDestination?: TargetDestination;
/**
* The target destination for the recommendation set.
*/
transformationTool?: TransformationTool;
}
export type RecommendationTaskId = string;
export interface RemoteSourceCodeAnalysisServerInfo {
/**
* The time when the remote source code server was configured.
*/
remoteSourceCodeAnalysisServerConfigurationTimestamp?: String;
}
export type ResourceId = string;
export type ResourceName = string;
export type ResourceSubType = "Database"|"Process"|"DatabaseProcess"|string;
export interface Result {
/**
* The erro