Skip to content

start_recommendations

start_recommendations(
    database_id: String,
    settings: RecommendationSettings,
    *,
    config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
) -> None

End of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support.

Starts the analysis of your source database to provide recommendations of target engines.

You can create recommendations for multiple source databases using BatchStartRecommendations.

Parameters:

  • database_id (String) –

    The identifier of the source database to analyze and provide recommendations for.

  • settings (RecommendationSettings) –

    The settings in JSON format that Fleet Advisor uses to determine target engine recommendations. These parameters include target instance sizing and availability and durability settings. For target instance sizing, Fleet Advisor supports the following two options: total capacity and resource utilization. For availability and durability, Fleet Advisor supports the following two options: production (Multi-AZ deployments) and Dev/Test (Single-AZ deployments).

Raises:

Source code in docs_src/capo_database_migration_service/_services/database_migration_service.py
def start_recommendations(
    self,
    database_id: "capo_database_migration_service.types.string.String",
    settings: "capo_database_migration_service.types.recommendation_settings.RecommendationSettings",
    *,
    config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
) -> None:
    """<important> <p> End of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/dms_fleet.advisor-end-of-support.html">Amazon Web Services DMS Fleet Advisor end of support</a>. </p> </important> <p>Starts the analysis of your source database to provide recommendations of target engines.</p> <p>You can create recommendations for multiple source databases using <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_BatchStartRecommendations.html">BatchStartRecommendations</a>.</p>

    Args:
        database_id: <p>The identifier of the source database to analyze and provide recommendations for.</p>
        settings: <p>The settings in JSON format that Fleet Advisor uses to determine target engine recommendations. These parameters include target instance sizing and availability and durability settings. For target instance sizing, Fleet Advisor supports the following two options: total capacity and resource utilization. For availability and durability, Fleet Advisor supports the following two options: production (Multi-AZ deployments) and Dev/Test (Single-AZ deployments).</p>

    Raises:
        capo_database_migration_service.errors.access_denied_fault.AccessDeniedFault: <p>DMS was denied access to the endpoint. Check that the role is correctly configured.</p>
        capo_database_migration_service.errors.invalid_resource_state_fault.InvalidResourceStateFault: <p>The resource is in a state that prevents it from being used for database migration.</p>
        capo_database_migration_service.errors.resource_not_found_fault.ResourceNotFoundFault: <p>The resource could not be found.</p>
        capo_database_migration_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_database_migration_service.types.start_recommendations_request.StartRecommendationsRequest]",
    ) -> OperationResponse[None]:
        import capo_database_migration_service._operations.amazon_dm_sv20160101.start_recommendations

        output, http_response = (
            capo_database_migration_service._operations.amazon_dm_sv20160101.start_recommendations.start_recommendations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartRecommendations")
    )
    input_: capo_database_migration_service.types.start_recommendations_request.StartRecommendationsRequest = {
        "database_id": database_id,
        "settings": settings,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output