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

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.

Usage example

client = boto3.client("migrationhubstrategy")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.DependencyException,
    client.InternalServerException,
    client.ResourceNotFoundException,
    client.ServiceLinkedRoleLockClientException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)

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

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

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

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

Method definition

def get_application_component_details(
    self,
    *,
    applicationComponentId: str,
) -> GetApplicationComponentDetailsResponseTypeDef:  # (1)
    ...

1. See GetApplicationComponentDetailsResponseTypeDef

Usage example with kwargs

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

Method definition

def get_application_component_strategies(
    self,
    *,
    applicationComponentId: str,
) -> GetApplicationComponentStrategiesResponseTypeDef:  # (1)
    ...

1. See GetApplicationComponentStrategiesResponseTypeDef

Usage example with kwargs

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

Method definition

def get_assessment(
    self,
    *,
    id: str,
) -> GetAssessmentResponseTypeDef:  # (1)
    ...

1. See GetAssessmentResponseTypeDef

Usage example with kwargs

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

Method definition

def get_import_file_task(
    self,
    *,
    id: str,
) -> GetImportFileTaskResponseTypeDef:  # (1)
    ...

1. See GetImportFileTaskResponseTypeDef

Usage example with kwargs

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

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

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

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

Method definition

def get_recommendation_report_details(
    self,
    *,
    id: str,
) -> GetRecommendationReportDetailsResponseTypeDef:  # (1)
    ...

1. See GetRecommendationReportDetailsResponseTypeDef

Usage example with kwargs

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

Method definition

def get_server_details(
    self,
    *,
    serverId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> GetServerDetailsResponseTypeDef:  # (1)
    ...

1. See GetServerDetailsResponseTypeDef

Usage example with kwargs

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

Method definition

def get_server_strategies(
    self,
    *,
    serverId: str,
) -> GetServerStrategiesResponseTypeDef:  # (1)
    ...

1. See GetServerStrategiesResponseTypeDef

Usage example with kwargs

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

parent.get_server_strategies(**kwargs)

1. See GetServerStrategiesRequestRequestTypeDef

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

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

Usage example with kwargs

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

Method definition

def list_collectors(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListCollectorsResponseTypeDef:  # (1)
    ...

1. See ListCollectorsResponseTypeDef

Usage example with kwargs

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

Method definition

def list_import_file_task(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListImportFileTaskResponseTypeDef:  # (1)
    ...

1. See ListImportFileTaskResponseTypeDef

Usage example with kwargs

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

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

Usage example with kwargs

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

Method definition

def put_portfolio_preferences(
    self,
    *,
    applicationMode: ApplicationModeType = ...,  # (1)
    applicationPreferences: ApplicationPreferencesTypeDef = ...,  # (2)
    databasePreferences: DatabasePreferencesTypeDef = ...,  # (3)
    prioritizeBusinessGoals: PrioritizeBusinessGoalsTypeDef = ...,  # (4)
) -> Dict[str, Any]:
    ...

1. See ApplicationModeType
2. See ApplicationPreferencesTypeDef
3. See DatabasePreferencesTypeDef
4. See PrioritizeBusinessGoalsTypeDef

Usage example with kwargs

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

Method definition

def start_assessment(
    self,
    *,
    assessmentTargets: Sequence[AssessmentTargetTypeDef] = ...,  # (1)
    s3bucketForAnalysisData: str = ...,
    s3bucketForReportData: str = ...,
) -> StartAssessmentResponseTypeDef:  # (2)
    ...

1. See AssessmentTargetTypeDef
2. See StartAssessmentResponseTypeDef

Usage example with kwargs

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

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

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

Usage example with kwargs

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

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

Usage example with kwargs

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

Method definition

def stop_assessment(
    self,
    *,
    assessmentId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

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

Usage example with kwargs

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

Method definition

def update_server_config(
    self,
    *,
    serverId: str,
    strategyOption: StrategyOptionTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See StrategyOptionTypeDef

Usage example with kwargs

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.

• client.get_paginator("get_server_details") -> GetServerDetailsPaginator
• client.get_paginator("list_application_components") -> ListApplicationComponentsPaginator
• client.get_paginator("list_collectors") -> ListCollectorsPaginator
• client.get_paginator("list_import_file_task") -> ListImportFileTaskPaginator
• client.get_paginator("list_servers") -> ListServersPaginator