Skip to content

MigrationHubStrategyRecommendationsClient#

Index > MigrationHubStrategyRecommendations > MigrationHubStrategyRecommendationsClient

Auto-generated documentation for MigrationHubStrategyRecommendations type annotations stubs module mypy-boto3-migrationhubstrategy.

MigrationHubStrategyRecommendationsClient#

Type annotations and code completion for boto3.client("migrationhubstrategy"). boto3 documentation

# MigrationHubStrategyRecommendationsClient usage example

from boto3.session import Session
from mypy_boto3_migrationhubstrategy.client import MigrationHubStrategyRecommendationsClient

def get_migrationhubstrategy_client() -> MigrationHubStrategyRecommendationsClient:
    return Session().client("migrationhubstrategy")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("migrationhubstrategy").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("migrationhubstrategy")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.DependencyException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceLinkedRoleLockClientException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_migrationhubstrategy.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("migrationhubstrategy").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("migrationhubstrategy").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("migrationhubstrategy").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_application_component_details#

Retrieves details about an application component.

Type annotations and code completion for boto3.client("migrationhubstrategy").get_application_component_details method. boto3 documentation

# get_application_component_details method definition

def get_application_component_details(
    self,
    *,
    applicationComponentId: str,
) -> GetApplicationComponentDetailsResponseTypeDef:  # (1)
    ...
  1. See GetApplicationComponentDetailsResponseTypeDef 
# get_application_component_details method usage example with argument unpacking

kwargs: GetApplicationComponentDetailsRequestRequestTypeDef = {  # (1)
    "applicationComponentId": ...,
}

parent.get_application_component_details(**kwargs)
  1. See GetApplicationComponentDetailsRequestRequestTypeDef

get_application_component_strategies#

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

Type annotations and code completion for boto3.client("migrationhubstrategy").get_application_component_strategies method. boto3 documentation

# get_application_component_strategies method definition

def get_application_component_strategies(
    self,
    *,
    applicationComponentId: str,
) -> GetApplicationComponentStrategiesResponseTypeDef:  # (1)
    ...
  1. See GetApplicationComponentStrategiesResponseTypeDef 
# get_application_component_strategies method usage example with argument unpacking

kwargs: GetApplicationComponentStrategiesRequestRequestTypeDef = {  # (1)
    "applicationComponentId": ...,
}

parent.get_application_component_strategies(**kwargs)
  1. See GetApplicationComponentStrategiesRequestRequestTypeDef

get_assessment#

Retrieves the status of an on-going assessment.

Type annotations and code completion for boto3.client("migrationhubstrategy").get_assessment method. boto3 documentation

# get_assessment method definition

def get_assessment(
    self,
    *,
    id: str,
) -> GetAssessmentResponseTypeDef:  # (1)
    ...
  1. See GetAssessmentResponseTypeDef 
# get_assessment method usage example with argument unpacking

kwargs: GetAssessmentRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_assessment(**kwargs)
  1. See GetAssessmentRequestRequestTypeDef

get_import_file_task#

Retrieves the details about a specific import task.

Type annotations and code completion for boto3.client("migrationhubstrategy").get_import_file_task method. boto3 documentation

# get_import_file_task method definition

def get_import_file_task(
    self,
    *,
    id: str,
) -> GetImportFileTaskResponseTypeDef:  # (1)
    ...
  1. See GetImportFileTaskResponseTypeDef 
# get_import_file_task method usage example with argument unpacking

kwargs: GetImportFileTaskRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_import_file_task(**kwargs)
  1. See GetImportFileTaskRequestRequestTypeDef

get_latest_assessment_id#

Retrieve the latest ID of a specific assessment task.

Type annotations and code completion for boto3.client("migrationhubstrategy").get_latest_assessment_id method. boto3 documentation

# get_latest_assessment_id method definition

def get_latest_assessment_id(
    self,
) -> GetLatestAssessmentIdResponseTypeDef:  # (1)
    ...
  1. See GetLatestAssessmentIdResponseTypeDef

get_portfolio_preferences#

Retrieves your migration and modernization preferences.

Type annotations and code completion for boto3.client("migrationhubstrategy").get_portfolio_preferences method. boto3 documentation

# get_portfolio_preferences method definition

def get_portfolio_preferences(
    self,
) -> GetPortfolioPreferencesResponseTypeDef:  # (1)
    ...
  1. See GetPortfolioPreferencesResponseTypeDef

get_portfolio_summary#

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

Type annotations and code completion for boto3.client("migrationhubstrategy").get_portfolio_summary method. boto3 documentation

# get_portfolio_summary method definition

def get_portfolio_summary(
    self,
) -> GetPortfolioSummaryResponseTypeDef:  # (1)
    ...
  1. See GetPortfolioSummaryResponseTypeDef

get_recommendation_report_details#

Retrieves detailed information about the specified recommendation report.

Type annotations and code completion for boto3.client("migrationhubstrategy").get_recommendation_report_details method. boto3 documentation

# get_recommendation_report_details method definition

def get_recommendation_report_details(
    self,
    *,
    id: str,
) -> GetRecommendationReportDetailsResponseTypeDef:  # (1)
    ...
  1. See GetRecommendationReportDetailsResponseTypeDef 
# get_recommendation_report_details method usage example with argument unpacking

kwargs: GetRecommendationReportDetailsRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_recommendation_report_details(**kwargs)
  1. See GetRecommendationReportDetailsRequestRequestTypeDef

get_server_details#

Retrieves detailed information about a specified server.

Type annotations and code completion for boto3.client("migrationhubstrategy").get_server_details method. boto3 documentation

# get_server_details method definition

def get_server_details(
    self,
    *,
    serverId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> GetServerDetailsResponseTypeDef:  # (1)
    ...
  1. See GetServerDetailsResponseTypeDef 
# get_server_details method usage example with argument unpacking

kwargs: GetServerDetailsRequestRequestTypeDef = {  # (1)
    "serverId": ...,
}

parent.get_server_details(**kwargs)
  1. See GetServerDetailsRequestRequestTypeDef

get_server_strategies#

Retrieves recommended strategies and tools for the specified server.

Type annotations and code completion for boto3.client("migrationhubstrategy").get_server_strategies method. boto3 documentation

# get_server_strategies method definition

def get_server_strategies(
    self,
    *,
    serverId: str,
) -> GetServerStrategiesResponseTypeDef:  # (1)
    ...
  1. See GetServerStrategiesResponseTypeDef 
# get_server_strategies method usage example with argument unpacking

kwargs: GetServerStrategiesRequestRequestTypeDef = {  # (1)
    "serverId": ...,
}

parent.get_server_strategies(**kwargs)
  1. See GetServerStrategiesRequestRequestTypeDef

list_analyzable_servers#

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

Type annotations and code completion for boto3.client("migrationhubstrategy").list_analyzable_servers method. boto3 documentation

# list_analyzable_servers method definition

def list_analyzable_servers(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    sort: SortOrderType = ...,  # (1)
) -> ListAnalyzableServersResponseTypeDef:  # (2)
    ...
  1. See SortOrderType
  2. See ListAnalyzableServersResponseTypeDef 
# list_analyzable_servers method usage example with argument unpacking

kwargs: ListAnalyzableServersRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_analyzable_servers(**kwargs)
  1. See ListAnalyzableServersRequestRequestTypeDef

list_application_components#

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

Type annotations and code completion for boto3.client("migrationhubstrategy").list_application_components method. boto3 documentation

# list_application_components method definition

def list_application_components(
    self,
    *,
    applicationComponentCriteria: ApplicationComponentCriteriaType = ...,  # (1)
    filterValue: str = ...,
    groupIdFilter: Sequence[GroupTypeDef] = ...,  # (2)
    maxResults: int = ...,
    nextToken: str = ...,
    sort: SortOrderType = ...,  # (3)
) -> ListApplicationComponentsResponseTypeDef:  # (4)
    ...
  1. See ApplicationComponentCriteriaType
  2. See GroupTypeDef
  3. See SortOrderType
  4. See ListApplicationComponentsResponseTypeDef 
# list_application_components method usage example with argument unpacking

kwargs: ListApplicationComponentsRequestRequestTypeDef = {  # (1)
    "applicationComponentCriteria": ...,
}

parent.list_application_components(**kwargs)
  1. See ListApplicationComponentsRequestRequestTypeDef

list_collectors#

Retrieves a list of all the installed collectors.

Type annotations and code completion for boto3.client("migrationhubstrategy").list_collectors method. boto3 documentation

# list_collectors method definition

def list_collectors(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListCollectorsResponseTypeDef:  # (1)
    ...
  1. See ListCollectorsResponseTypeDef 
# list_collectors method usage example with argument unpacking

kwargs: ListCollectorsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_collectors(**kwargs)
  1. See ListCollectorsRequestRequestTypeDef

list_import_file_task#

Retrieves a list of all the imports performed.

Type annotations and code completion for boto3.client("migrationhubstrategy").list_import_file_task method. boto3 documentation

# list_import_file_task method definition

def list_import_file_task(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListImportFileTaskResponseTypeDef:  # (1)
    ...
  1. See ListImportFileTaskResponseTypeDef 
# list_import_file_task method usage example with argument unpacking

kwargs: ListImportFileTaskRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_import_file_task(**kwargs)
  1. See ListImportFileTaskRequestRequestTypeDef

list_servers#

Returns a list of all the servers.

Type annotations and code completion for boto3.client("migrationhubstrategy").list_servers method. boto3 documentation

# list_servers method definition

def list_servers(
    self,
    *,
    filterValue: str = ...,
    groupIdFilter: Sequence[GroupTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
    serverCriteria: ServerCriteriaType = ...,  # (2)
    sort: SortOrderType = ...,  # (3)
) -> ListServersResponseTypeDef:  # (4)
    ...
  1. See GroupTypeDef
  2. See ServerCriteriaType
  3. See SortOrderType
  4. See ListServersResponseTypeDef 
# list_servers method usage example with argument unpacking

kwargs: ListServersRequestRequestTypeDef = {  # (1)
    "filterValue": ...,
}

parent.list_servers(**kwargs)
  1. See ListServersRequestRequestTypeDef

put_portfolio_preferences#

Saves the specified migration and modernization preferences.

Type annotations and code completion for boto3.client("migrationhubstrategy").put_portfolio_preferences method. boto3 documentation

# put_portfolio_preferences method definition

def put_portfolio_preferences(
    self,
    *,
    applicationMode: ApplicationModeType = ...,  # (1)
    applicationPreferences: Union[ApplicationPreferencesTypeDef, ApplicationPreferencesOutputTypeDef] = ...,  # (2)
    databasePreferences: Union[DatabasePreferencesTypeDef, DatabasePreferencesOutputTypeDef] = ...,  # (3)
    prioritizeBusinessGoals: PrioritizeBusinessGoalsTypeDef = ...,  # (4)
) -> Dict[str, Any]:
    ...
  1. See ApplicationModeType
  2. See ApplicationPreferencesTypeDef ApplicationPreferencesOutputTypeDef
  3. See DatabasePreferencesTypeDef DatabasePreferencesOutputTypeDef
  4. See PrioritizeBusinessGoalsTypeDef 
# put_portfolio_preferences method usage example with argument unpacking

kwargs: PutPortfolioPreferencesRequestRequestTypeDef = {  # (1)
    "applicationMode": ...,
}

parent.put_portfolio_preferences(**kwargs)
  1. See PutPortfolioPreferencesRequestRequestTypeDef

start_assessment#

Starts the assessment of an on-premises environment.

Type annotations and code completion for boto3.client("migrationhubstrategy").start_assessment method. boto3 documentation

# start_assessment method definition

def start_assessment(
    self,
    *,
    assessmentDataSourceType: AssessmentDataSourceTypeType = ...,  # (1)
    assessmentTargets: Sequence[Union[AssessmentTargetTypeDef, AssessmentTargetOutputTypeDef]] = ...,  # (2)
    s3bucketForAnalysisData: str = ...,
    s3bucketForReportData: str = ...,
) -> StartAssessmentResponseTypeDef:  # (3)
    ...
  1. See AssessmentDataSourceTypeType
  2. See AssessmentTargetTypeDef AssessmentTargetOutputTypeDef
  3. See StartAssessmentResponseTypeDef 
# start_assessment method usage example with argument unpacking

kwargs: StartAssessmentRequestRequestTypeDef = {  # (1)
    "assessmentDataSourceType": ...,
}

parent.start_assessment(**kwargs)
  1. See StartAssessmentRequestRequestTypeDef

start_import_file_task#

Starts a file import.

Type annotations and code completion for boto3.client("migrationhubstrategy").start_import_file_task method. boto3 documentation

# start_import_file_task method definition

def start_import_file_task(
    self,
    *,
    S3Bucket: str,
    name: str,
    s3key: str,
    dataSourceType: DataSourceTypeType = ...,  # (1)
    groupId: Sequence[GroupTypeDef] = ...,  # (2)
    s3bucketForReportData: str = ...,
) -> StartImportFileTaskResponseTypeDef:  # (3)
    ...
  1. See DataSourceTypeType
  2. See GroupTypeDef
  3. See StartImportFileTaskResponseTypeDef 
# start_import_file_task method usage example with argument unpacking

kwargs: StartImportFileTaskRequestRequestTypeDef = {  # (1)
    "S3Bucket": ...,
    "name": ...,
    "s3key": ...,
}

parent.start_import_file_task(**kwargs)
  1. See StartImportFileTaskRequestRequestTypeDef

start_recommendation_report_generation#

Starts generating a recommendation report.

Type annotations and code completion for boto3.client("migrationhubstrategy").start_recommendation_report_generation method. boto3 documentation

# start_recommendation_report_generation method definition

def start_recommendation_report_generation(
    self,
    *,
    groupIdFilter: Sequence[GroupTypeDef] = ...,  # (1)
    outputFormat: OutputFormatType = ...,  # (2)
) -> StartRecommendationReportGenerationResponseTypeDef:  # (3)
    ...
  1. See GroupTypeDef
  2. See OutputFormatType
  3. See StartRecommendationReportGenerationResponseTypeDef 
# start_recommendation_report_generation method usage example with argument unpacking

kwargs: StartRecommendationReportGenerationRequestRequestTypeDef = {  # (1)
    "groupIdFilter": ...,
}

parent.start_recommendation_report_generation(**kwargs)
  1. See StartRecommendationReportGenerationRequestRequestTypeDef

stop_assessment#

Stops the assessment of an on-premises environment.

Type annotations and code completion for boto3.client("migrationhubstrategy").stop_assessment method. boto3 documentation

# stop_assessment method definition

def stop_assessment(
    self,
    *,
    assessmentId: str,
) -> Dict[str, Any]:
    ...
# stop_assessment method usage example with argument unpacking

kwargs: StopAssessmentRequestRequestTypeDef = {  # (1)
    "assessmentId": ...,
}

parent.stop_assessment(**kwargs)
  1. See StopAssessmentRequestRequestTypeDef

update_application_component_config#

Updates the configuration of an application component.

Type annotations and code completion for boto3.client("migrationhubstrategy").update_application_component_config method. boto3 documentation

# update_application_component_config method definition

def update_application_component_config(
    self,
    *,
    applicationComponentId: str,
    appType: AppTypeType = ...,  # (1)
    configureOnly: bool = ...,
    inclusionStatus: InclusionStatusType = ...,  # (2)
    secretsManagerKey: str = ...,
    sourceCodeList: Sequence[SourceCodeTypeDef] = ...,  # (3)
    strategyOption: StrategyOptionTypeDef = ...,  # (4)
) -> Dict[str, Any]:
    ...
  1. See AppTypeType
  2. See InclusionStatusType
  3. See SourceCodeTypeDef
  4. See StrategyOptionTypeDef 
# update_application_component_config method usage example with argument unpacking

kwargs: UpdateApplicationComponentConfigRequestRequestTypeDef = {  # (1)
    "applicationComponentId": ...,
}

parent.update_application_component_config(**kwargs)
  1. See UpdateApplicationComponentConfigRequestRequestTypeDef

update_server_config#

Updates the configuration of the specified server.

Type annotations and code completion for boto3.client("migrationhubstrategy").update_server_config method. boto3 documentation

# update_server_config method definition

def update_server_config(
    self,
    *,
    serverId: str,
    strategyOption: StrategyOptionTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See StrategyOptionTypeDef 
# update_server_config method usage example with argument unpacking

kwargs: UpdateServerConfigRequestRequestTypeDef = {  # (1)
    "serverId": ...,
}

parent.update_server_config(**kwargs)
  1. See UpdateServerConfigRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("migrationhubstrategy").get_paginator method with overloads.