com.amazonaws.services.migrationhubstrategyrecommendations

Class AWSMigrationHubStrategyRecommendationsClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.migrationhubstrategyrecommendations.AWSMigrationHubStrategyRecommendationsClient

All Implemented Interfaces:

AWSMigrationHubStrategyRecommendations

Direct Known Subclasses:

AWSMigrationHubStrategyRecommendationsAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSMigrationHubStrategyRecommendationsClient
extends AmazonWebServiceClient
implements AWSMigrationHubStrategyRecommendations

Client for accessing Migration Hub Strategy Recommendations. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.migrationhubstrategyrecommendations.AWSMigrationHubStrategyRecommendations

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSMigrationHubStrategyRecommendationsClientBuilder	builder()
GetApplicationComponentDetailsResult	getApplicationComponentDetails(GetApplicationComponentDetailsRequest request) Retrieves details about an application component.
GetApplicationComponentStrategiesResult	getApplicationComponentStrategies(GetApplicationComponentStrategiesRequest request) Retrieves a list of all the recommended strategies and tools for an application component running on a server.
GetAssessmentResult	getAssessment(GetAssessmentRequest request) 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 request) Retrieves the details about a specific import task.
GetLatestAssessmentIdResult	getLatestAssessmentId(GetLatestAssessmentIdRequest request) Retrieve the latest ID of a specific assessment task.
GetPortfolioPreferencesResult	getPortfolioPreferences(GetPortfolioPreferencesRequest request) Retrieves your migration and modernization preferences.
GetPortfolioSummaryResult	getPortfolioSummary(GetPortfolioSummaryRequest request) Retrieves overall summary including the number of servers to rehost and the overall number of anti-patterns.
GetRecommendationReportDetailsResult	getRecommendationReportDetails(GetRecommendationReportDetailsRequest request) Retrieves detailed information about the specified recommendation report.
GetServerDetailsResult	getServerDetails(GetServerDetailsRequest request) Retrieves detailed information about a specified server.
GetServerStrategiesResult	getServerStrategies(GetServerStrategiesRequest request) Retrieves recommended strategies and tools for the specified server.
ListAnalyzableServersResult	listAnalyzableServers(ListAnalyzableServersRequest request) Retrieves a list of all the servers fetched from customer vCenter using Strategy Recommendation Collector.
ListApplicationComponentsResult	listApplicationComponents(ListApplicationComponentsRequest request) Retrieves a list of all the application components (processes).
ListCollectorsResult	listCollectors(ListCollectorsRequest request) Retrieves a list of all the installed collectors.
ListImportFileTaskResult	listImportFileTask(ListImportFileTaskRequest request) Retrieves a list of all the imports performed.
ListServersResult	listServers(ListServersRequest request) Returns a list of all the servers.
PutPortfolioPreferencesResult	putPortfolioPreferences(PutPortfolioPreferencesRequest request) 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 request) Starts the assessment of an on-premises environment.
StartImportFileTaskResult	startImportFileTask(StartImportFileTaskRequest request) Starts a file import.
StartRecommendationReportGenerationResult	startRecommendationReportGeneration(StartRecommendationReportGenerationRequest request) Starts generating a recommendation report.
StopAssessmentResult	stopAssessment(StopAssessmentRequest request) Stops the assessment of an on-premises environment.
UpdateApplicationComponentConfigResult	updateApplicationComponentConfig(UpdateApplicationComponentConfigRequest request) Updates the configuration of an application component.
UpdateServerConfigResult	updateServerConfig(UpdateServerConfigRequest request) Updates the configuration of the specified server.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSMigrationHubStrategyRecommendationsClientBuilder builder()

getApplicationComponentDetails

public GetApplicationComponentDetailsResult getApplicationComponentDetails(GetApplicationComponentDetailsRequest request)

Retrieves details about an application component.

Specified by:

getApplicationComponentDetails in interface AWSMigrationHubStrategyRecommendations

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

public GetApplicationComponentStrategiesResult getApplicationComponentStrategies(GetApplicationComponentStrategiesRequest request)

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

Specified by:

getApplicationComponentStrategies in interface AWSMigrationHubStrategyRecommendations

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

public GetAssessmentResult getAssessment(GetAssessmentRequest request)

Retrieves the status of an on-going assessment.

Specified by:

getAssessment in interface AWSMigrationHubStrategyRecommendations

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

public GetImportFileTaskResult getImportFileTask(GetImportFileTaskRequest request)

Retrieves the details about a specific import task.

Specified by:

getImportFileTask in interface AWSMigrationHubStrategyRecommendations

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

public GetLatestAssessmentIdResult getLatestAssessmentId(GetLatestAssessmentIdRequest request)

Retrieve the latest ID of a specific assessment task.

Specified by:

getLatestAssessmentId in interface AWSMigrationHubStrategyRecommendations

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

public GetPortfolioPreferencesResult getPortfolioPreferences(GetPortfolioPreferencesRequest request)

Retrieves your migration and modernization preferences.

Specified by:

getPortfolioPreferences in interface AWSMigrationHubStrategyRecommendations

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

public GetPortfolioSummaryResult getPortfolioSummary(GetPortfolioSummaryRequest request)

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

Specified by:

getPortfolioSummary in interface AWSMigrationHubStrategyRecommendations

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

public GetRecommendationReportDetailsResult getRecommendationReportDetails(GetRecommendationReportDetailsRequest request)

Retrieves detailed information about the specified recommendation report.

Specified by:

getRecommendationReportDetails in interface AWSMigrationHubStrategyRecommendations

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

public GetServerDetailsResult getServerDetails(GetServerDetailsRequest request)

Retrieves detailed information about a specified server.

Specified by:

getServerDetails in interface AWSMigrationHubStrategyRecommendations

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

public GetServerStrategiesResult getServerStrategies(GetServerStrategiesRequest request)

Retrieves recommended strategies and tools for the specified server.

Specified by:

getServerStrategies in interface AWSMigrationHubStrategyRecommendations

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

public ListAnalyzableServersResult listAnalyzableServers(ListAnalyzableServersRequest request)

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

Specified by:

listAnalyzableServers in interface AWSMigrationHubStrategyRecommendations

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

public ListApplicationComponentsResult listApplicationComponents(ListApplicationComponentsRequest request)

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

Specified by:

listApplicationComponents in interface AWSMigrationHubStrategyRecommendations

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

public ListCollectorsResult listCollectors(ListCollectorsRequest request)

Retrieves a list of all the installed collectors.

Specified by:

listCollectors in interface AWSMigrationHubStrategyRecommendations

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

public ListImportFileTaskResult listImportFileTask(ListImportFileTaskRequest request)

Retrieves a list of all the imports performed.

Specified by:

listImportFileTask in interface AWSMigrationHubStrategyRecommendations

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

public ListServersResult listServers(ListServersRequest request)

Returns a list of all the servers.

Specified by:

listServers in interface AWSMigrationHubStrategyRecommendations

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

public PutPortfolioPreferencesResult putPortfolioPreferences(PutPortfolioPreferencesRequest request)

Saves the specified migration and modernization preferences.

Specified by:

putPortfolioPreferences in interface AWSMigrationHubStrategyRecommendations

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

public StartAssessmentResult startAssessment(StartAssessmentRequest request)

Starts the assessment of an on-premises environment.

Specified by:

startAssessment in interface AWSMigrationHubStrategyRecommendations

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

public StartImportFileTaskResult startImportFileTask(StartImportFileTaskRequest request)

Starts a file import.

Specified by:

startImportFileTask in interface AWSMigrationHubStrategyRecommendations

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

public StartRecommendationReportGenerationResult startRecommendationReportGeneration(StartRecommendationReportGenerationRequest request)

Starts generating a recommendation report.

Specified by:

startRecommendationReportGeneration in interface AWSMigrationHubStrategyRecommendations

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

public StopAssessmentResult stopAssessment(StopAssessmentRequest request)

Stops the assessment of an on-premises environment.

Specified by:

stopAssessment in interface AWSMigrationHubStrategyRecommendations

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

public UpdateApplicationComponentConfigResult updateApplicationComponentConfig(UpdateApplicationComponentConfigRequest request)

Updates the configuration of an application component.

Specified by:

updateApplicationComponentConfig in interface AWSMigrationHubStrategyRecommendations

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

public UpdateServerConfigResult updateServerConfig(UpdateServerConfigRequest request)

Updates the configuration of the specified server.

Specified by:

updateServerConfig in interface AWSMigrationHubStrategyRecommendations

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSMigrationHubStrategyRecommendations

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSMigrationHubStrategyRecommendations

Overrides:

shutdown in class AmazonWebServiceClient