com.amazonaws.services.migrationhubstrategyrecommendations

Interface AWSMigrationHubStrategyRecommendations

All Known Subinterfaces:

AWSMigrationHubStrategyRecommendationsAsync

All Known Implementing Classes:

AbstractAWSMigrationHubStrategyRecommendations, AbstractAWSMigrationHubStrategyRecommendationsAsync, AWSMigrationHubStrategyRecommendationsAsyncClient, AWSMigrationHubStrategyRecommendationsClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSMigrationHubStrategyRecommendations

Interface for accessing Migration Hub Strategy Recommendations.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSMigrationHubStrategyRecommendations instead.

Migration Hub Strategy Recommendations

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 AWS SDKs.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
GetApplicationComponentDetailsResult	getApplicationComponentDetails(GetApplicationComponentDetailsRequest getApplicationComponentDetailsRequest) Retrieves details about an application component.
GetApplicationComponentStrategiesResult	getApplicationComponentStrategies(GetApplicationComponentStrategiesRequest getApplicationComponentStrategiesRequest) Retrieves a list of all the recommended strategies and tools for an application component running on a server.
GetAssessmentResult	getAssessment(GetAssessmentRequest getAssessmentRequest) Retrieves the status of an on-going assessment.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetImportFileTaskResult	getImportFileTask(GetImportFileTaskRequest getImportFileTaskRequest) Retrieves the details about a specific import task.
GetLatestAssessmentIdResult	getLatestAssessmentId(GetLatestAssessmentIdRequest getLatestAssessmentIdRequest) Retrieve the latest ID of a specific assessment task.
GetPortfolioPreferencesResult	getPortfolioPreferences(GetPortfolioPreferencesRequest getPortfolioPreferencesRequest) Retrieves your migration and modernization preferences.
GetPortfolioSummaryResult	getPortfolioSummary(GetPortfolioSummaryRequest getPortfolioSummaryRequest) Retrieves overall summary including the number of servers to rehost and the overall number of anti-patterns.
GetRecommendationReportDetailsResult	getRecommendationReportDetails(GetRecommendationReportDetailsRequest getRecommendationReportDetailsRequest) Retrieves detailed information about the specified recommendation report.
GetServerDetailsResult	getServerDetails(GetServerDetailsRequest getServerDetailsRequest) Retrieves detailed information about a specified server.
GetServerStrategiesResult	getServerStrategies(GetServerStrategiesRequest getServerStrategiesRequest) Retrieves recommended strategies and tools for the specified server.
ListAnalyzableServersResult	listAnalyzableServers(ListAnalyzableServersRequest listAnalyzableServersRequest) Retrieves a list of all the servers fetched from customer vCenter using Strategy Recommendation Collector.
ListApplicationComponentsResult	listApplicationComponents(ListApplicationComponentsRequest listApplicationComponentsRequest) Retrieves a list of all the application components (processes).
ListCollectorsResult	listCollectors(ListCollectorsRequest listCollectorsRequest) Retrieves a list of all the installed collectors.
ListImportFileTaskResult	listImportFileTask(ListImportFileTaskRequest listImportFileTaskRequest) Retrieves a list of all the imports performed.
ListServersResult	listServers(ListServersRequest listServersRequest) Returns a list of all the servers.
PutPortfolioPreferencesResult	putPortfolioPreferences(PutPortfolioPreferencesRequest putPortfolioPreferencesRequest) Saves the specified migration and modernization preferences.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartAssessmentResult	startAssessment(StartAssessmentRequest startAssessmentRequest) Starts the assessment of an on-premises environment.
StartImportFileTaskResult	startImportFileTask(StartImportFileTaskRequest startImportFileTaskRequest) Starts a file import.
StartRecommendationReportGenerationResult	startRecommendationReportGeneration(StartRecommendationReportGenerationRequest startRecommendationReportGenerationRequest) Starts generating a recommendation report.
StopAssessmentResult	stopAssessment(StopAssessmentRequest stopAssessmentRequest) Stops the assessment of an on-premises environment.
UpdateApplicationComponentConfigResult	updateApplicationComponentConfig(UpdateApplicationComponentConfigRequest updateApplicationComponentConfigRequest) Updates the configuration of an application component.
UpdateServerConfigResult	updateServerConfig(UpdateServerConfigRequest updateServerConfigRequest) Updates the configuration of the specified server.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

getApplicationComponentDetails

GetApplicationComponentDetailsResult getApplicationComponentDetails(GetApplicationComponentDetailsRequest getApplicationComponentDetailsRequest)

Retrieves details about an application component.

Parameters:

getApplicationComponentDetailsRequest -

Returns:

Result of the GetApplicationComponentDetails operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getApplicationComponentStrategies

GetApplicationComponentStrategiesResult getApplicationComponentStrategies(GetApplicationComponentStrategiesRequest getApplicationComponentStrategiesRequest)

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

Parameters:

getApplicationComponentStrategiesRequest -

Returns:

Result of the GetApplicationComponentStrategies operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getAssessment

GetAssessmentResult getAssessment(GetAssessmentRequest getAssessmentRequest)

Retrieves the status of an on-going assessment.

Parameters:

getAssessmentRequest -

Returns:

Result of the GetAssessment operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getImportFileTask

GetImportFileTaskResult getImportFileTask(GetImportFileTaskRequest getImportFileTaskRequest)

Retrieves the details about a specific import task.

Parameters:

getImportFileTaskRequest -

Returns:

Result of the GetImportFileTask operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getLatestAssessmentId

GetLatestAssessmentIdResult getLatestAssessmentId(GetLatestAssessmentIdRequest getLatestAssessmentIdRequest)

Retrieve the latest ID of a specific assessment task.

Parameters:

getLatestAssessmentIdRequest -

Returns:

Result of the GetLatestAssessmentId operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getPortfolioPreferences

GetPortfolioPreferencesResult getPortfolioPreferences(GetPortfolioPreferencesRequest getPortfolioPreferencesRequest)

Retrieves your migration and modernization preferences.

Parameters:

getPortfolioPreferencesRequest -

Returns:

Result of the GetPortfolioPreferences operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getPortfolioSummary

GetPortfolioSummaryResult getPortfolioSummary(GetPortfolioSummaryRequest getPortfolioSummaryRequest)

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

Parameters:

getPortfolioSummaryRequest -

Returns:

Result of the GetPortfolioSummary operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getRecommendationReportDetails

GetRecommendationReportDetailsResult getRecommendationReportDetails(GetRecommendationReportDetailsRequest getRecommendationReportDetailsRequest)

Retrieves detailed information about the specified recommendation report.

Parameters:

getRecommendationReportDetailsRequest -

Returns:

Result of the GetRecommendationReportDetails operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getServerDetails

GetServerDetailsResult getServerDetails(GetServerDetailsRequest getServerDetailsRequest)

Retrieves detailed information about a specified server.

Parameters:

getServerDetailsRequest -

Returns:

Result of the GetServerDetails operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getServerStrategies

GetServerStrategiesResult getServerStrategies(GetServerStrategiesRequest getServerStrategiesRequest)

Retrieves recommended strategies and tools for the specified server.

Parameters:

getServerStrategiesRequest -

Returns:

Result of the GetServerStrategies operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listAnalyzableServers

ListAnalyzableServersResult listAnalyzableServers(ListAnalyzableServersRequest listAnalyzableServersRequest)

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

Parameters:

listAnalyzableServersRequest - Represents input for ListAnalyzableServers operation.

Returns:

Result of the ListAnalyzableServers operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listApplicationComponents

ListApplicationComponentsResult listApplicationComponents(ListApplicationComponentsRequest listApplicationComponentsRequest)

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

Parameters:

listApplicationComponentsRequest -

Returns:

Result of the ListApplicationComponents operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listCollectors

ListCollectorsResult listCollectors(ListCollectorsRequest listCollectorsRequest)

Retrieves a list of all the installed collectors.

Parameters:

listCollectorsRequest -

Returns:

Result of the ListCollectors operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listImportFileTask

ListImportFileTaskResult listImportFileTask(ListImportFileTaskRequest listImportFileTaskRequest)

Retrieves a list of all the imports performed.

Parameters:

listImportFileTaskRequest -

Returns:

Result of the ListImportFileTask operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listServers

ListServersResult listServers(ListServersRequest listServersRequest)

Returns a list of all the servers.

Parameters:

listServersRequest -

Returns:

Result of the ListServers operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

putPortfolioPreferences

PutPortfolioPreferencesResult putPortfolioPreferences(PutPortfolioPreferencesRequest putPortfolioPreferencesRequest)

Saves the specified migration and modernization preferences.

Parameters:

putPortfolioPreferencesRequest -

Returns:

Result of the PutPortfolioPreferences operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

startAssessment

StartAssessmentResult startAssessment(StartAssessmentRequest startAssessmentRequest)

Starts the assessment of an on-premises environment.

Parameters:

startAssessmentRequest -

Returns:

Result of the StartAssessment operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

startImportFileTask

StartImportFileTaskResult startImportFileTask(StartImportFileTaskRequest startImportFileTaskRequest)

Starts a file import.

Parameters:

startImportFileTaskRequest -

Returns:

Result of the StartImportFileTask operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

startRecommendationReportGeneration

StartRecommendationReportGenerationResult startRecommendationReportGeneration(StartRecommendationReportGenerationRequest startRecommendationReportGenerationRequest)

Starts generating a recommendation report.

Parameters:

startRecommendationReportGenerationRequest -

Returns:

Result of the StartRecommendationReportGeneration operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

stopAssessment

StopAssessmentResult stopAssessment(StopAssessmentRequest stopAssessmentRequest)

Stops the assessment of an on-premises environment.

Parameters:

stopAssessmentRequest -

Returns:

Result of the StopAssessment operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateApplicationComponentConfig

UpdateApplicationComponentConfigResult updateApplicationComponentConfig(UpdateApplicationComponentConfigRequest updateApplicationComponentConfigRequest)

Updates the configuration of an application component.

Parameters:

updateApplicationComponentConfigRequest -

Returns:

Result of the UpdateApplicationComponentConfig operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateServerConfig

UpdateServerConfigResult updateServerConfig(UpdateServerConfigRequest updateServerConfigRequest)

Updates the configuration of the specified server.

Parameters:

updateServerConfigRequest -

Returns:

Result of the UpdateServerConfig operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.