/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.migrationhubstrategyrecommendations; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.migrationhubstrategyrecommendations.model.*; /** * Interface for accessing Migration Hub Strategy Recommendations. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.migrationhubstrategyrecommendations.AbstractAWSMigrationHubStrategyRecommendations} * instead. *
**
*
* 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. *
* */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSMigrationHubStrategyRecommendations { /** * 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 RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "migrationhub-strategy"; /** ** Retrieves details about an application component. *
* * @param getApplicationComponentDetailsRequest * @return Result of the GetApplicationComponentDetails operation returned by the service. * @throws ResourceNotFoundException * The specified ID in the request is not found. * @throws ThrottlingException * The request was denied due to request throttling. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.GetApplicationComponentDetails * @see AWS API Documentation */ GetApplicationComponentDetailsResult getApplicationComponentDetails(GetApplicationComponentDetailsRequest getApplicationComponentDetailsRequest); /** ** Retrieves a list of all the recommended strategies and tools for an application component running on a server. *
* * @param getApplicationComponentStrategiesRequest * @return Result of the GetApplicationComponentStrategies operation returned by the service. * @throws ResourceNotFoundException * The specified ID in the request is not found. * @throws ThrottlingException * The request was denied due to request throttling. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.GetApplicationComponentStrategies * @see AWS API Documentation */ GetApplicationComponentStrategiesResult getApplicationComponentStrategies(GetApplicationComponentStrategiesRequest getApplicationComponentStrategiesRequest); /** ** Retrieves the status of an on-going assessment. *
* * @param getAssessmentRequest * @return Result of the GetAssessment operation returned by the service. * @throws ResourceNotFoundException * The specified ID in the request is not found. * @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. * @throws ThrottlingException * The request was denied due to request throttling. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.GetAssessment * @see AWS API Documentation */ GetAssessmentResult getAssessment(GetAssessmentRequest getAssessmentRequest); /** ** Retrieves the details about a specific import task. *
* * @param getImportFileTaskRequest * @return Result of the GetImportFileTask operation returned by the service. * @throws ResourceNotFoundException * The specified ID in the request is not found. * @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. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The request body isn't valid. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.GetImportFileTask * @see AWS API Documentation */ GetImportFileTaskResult getImportFileTask(GetImportFileTaskRequest getImportFileTaskRequest); /** ** Retrieve the latest ID of a specific assessment task. *
* * @param getLatestAssessmentIdRequest * @return Result of the GetLatestAssessmentId operation returned by the service. * @throws DependencyException * Dependency encountered an error. * @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. * @throws ValidationException * The request body isn't valid. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.GetLatestAssessmentId * @see AWS API Documentation */ GetLatestAssessmentIdResult getLatestAssessmentId(GetLatestAssessmentIdRequest getLatestAssessmentIdRequest); /** ** Retrieves your migration and modernization preferences. *
* * @param getPortfolioPreferencesRequest * @return Result of the GetPortfolioPreferences operation returned by the service. * @throws ResourceNotFoundException * The specified ID in the request is not found. * @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. * @throws ThrottlingException * The request was denied due to request throttling. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.GetPortfolioPreferences * @see AWS API Documentation */ GetPortfolioPreferencesResult getPortfolioPreferences(GetPortfolioPreferencesRequest getPortfolioPreferencesRequest); /** ** Retrieves overall summary including the number of servers to rehost and the overall number of anti-patterns. *
* * @param getPortfolioSummaryRequest * @return 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. * @throws ThrottlingException * The request was denied due to request throttling. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.GetPortfolioSummary * @see AWS API Documentation */ GetPortfolioSummaryResult getPortfolioSummary(GetPortfolioSummaryRequest getPortfolioSummaryRequest); /** ** Retrieves detailed information about the specified recommendation report. *
* * @param getRecommendationReportDetailsRequest * @return Result of the GetRecommendationReportDetails operation returned by the service. * @throws ResourceNotFoundException * The specified ID in the request is not found. * @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. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The request body isn't valid. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.GetRecommendationReportDetails * @see AWS API Documentation */ GetRecommendationReportDetailsResult getRecommendationReportDetails(GetRecommendationReportDetailsRequest getRecommendationReportDetailsRequest); /** ** Retrieves detailed information about a specified server. *
* * @param getServerDetailsRequest * @return Result of the GetServerDetails operation returned by the service. * @throws ResourceNotFoundException * The specified ID in the request is not found. * @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. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The request body isn't valid. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.GetServerDetails * @see AWS API Documentation */ GetServerDetailsResult getServerDetails(GetServerDetailsRequest getServerDetailsRequest); /** ** Retrieves recommended strategies and tools for the specified server. *
* * @param getServerStrategiesRequest * @return Result of the GetServerStrategies operation returned by the service. * @throws ResourceNotFoundException * The specified ID in the request is not found. * @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. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The request body isn't valid. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.GetServerStrategies * @see AWS API Documentation */ GetServerStrategiesResult getServerStrategies(GetServerStrategiesRequest getServerStrategiesRequest); /** ** Retrieves a list of all the application components (processes). *
* * @param listApplicationComponentsRequest * @return 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. * @throws ServiceLinkedRoleLockClientException * Exception to indicate that the service-linked role (SLR) is locked. * @throws ValidationException * The request body isn't valid. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.ListApplicationComponents * @see AWS API Documentation */ ListApplicationComponentsResult listApplicationComponents(ListApplicationComponentsRequest listApplicationComponentsRequest); /** ** Retrieves a list of all the installed collectors. *
* * @param listCollectorsRequest * @return 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. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The request body isn't valid. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.ListCollectors * @see AWS API Documentation */ ListCollectorsResult listCollectors(ListCollectorsRequest listCollectorsRequest); /** ** Retrieves a list of all the imports performed. *
* * @param listImportFileTaskRequest * @return 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. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The request body isn't valid. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.ListImportFileTask * @see AWS API Documentation */ ListImportFileTaskResult listImportFileTask(ListImportFileTaskRequest listImportFileTaskRequest); /** ** Returns a list of all the servers. *
* * @param listServersRequest * @return 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. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The request body isn't valid. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.ListServers * @see AWS API Documentation */ ListServersResult listServers(ListServersRequest listServersRequest); /** ** Saves the specified migration and modernization preferences. *
* * @param putPortfolioPreferencesRequest * @return 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. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The request body isn't valid. * @throws ConflictException * Exception to indicate that there is an ongoing task when a new task is created. Return when once the * existing tasks are complete. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.PutPortfolioPreferences * @see AWS API Documentation */ PutPortfolioPreferencesResult putPortfolioPreferences(PutPortfolioPreferencesRequest putPortfolioPreferencesRequest); /** ** Starts the assessment of an on-premises environment. *
* * @param startAssessmentRequest * @return 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. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ServiceQuotaExceededException * The AWS account has reached its quota of imports. Contact AWS Support to increase the quota for this * account. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.StartAssessment * @see AWS API Documentation */ StartAssessmentResult startAssessment(StartAssessmentRequest startAssessmentRequest); /** ** Starts a file import. *
* * @param startImportFileTaskRequest * @return 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. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ServiceQuotaExceededException * The AWS account has reached its quota of imports. Contact AWS Support to increase the quota for this * account. * @throws ValidationException * The request body isn't valid. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.StartImportFileTask * @see AWS API Documentation */ StartImportFileTaskResult startImportFileTask(StartImportFileTaskRequest startImportFileTaskRequest); /** ** Starts generating a recommendation report. *
* * @param startRecommendationReportGenerationRequest * @return 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. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The request body isn't valid. * @throws ConflictException * Exception to indicate that there is an ongoing task when a new task is created. Return when once the * existing tasks are complete. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.StartRecommendationReportGeneration * @see AWS API Documentation */ StartRecommendationReportGenerationResult startRecommendationReportGeneration( StartRecommendationReportGenerationRequest startRecommendationReportGenerationRequest); /** ** Stops the assessment of an on-premises environment. *
* * @param stopAssessmentRequest * @return 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. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The request body isn't valid. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.StopAssessment * @see AWS API Documentation */ StopAssessmentResult stopAssessment(StopAssessmentRequest stopAssessmentRequest); /** ** Updates the configuration of an application component. *
* * @param updateApplicationComponentConfigRequest * @return Result of the UpdateApplicationComponentConfig operation returned by the service. * @throws ResourceNotFoundException * The specified ID in the request is not found. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The request body isn't valid. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.UpdateApplicationComponentConfig * @see AWS API Documentation */ UpdateApplicationComponentConfigResult updateApplicationComponentConfig(UpdateApplicationComponentConfigRequest updateApplicationComponentConfigRequest); /** ** Updates the configuration of the specified server. *
* * @param updateServerConfigRequest * @return Result of the UpdateServerConfig operation returned by the service. * @throws ResourceNotFoundException * The specified ID in the request is not found. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The request body isn't valid. * @throws InternalServerException * The server experienced an internal error. Try again. * @sample AWSMigrationHubStrategyRecommendations.UpdateServerConfig * @see AWS API Documentation */ UpdateServerConfigResult updateServerConfig(UpdateServerConfigRequest updateServerConfigRequest); /** * 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. */ void shutdown(); /** * 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. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }