Skip to content

stop_assessment

stop_assessment(
    assessment_id: AsyncTaskId,
    *,
    config_overrides: Optional[MigrationHubStrategyClientConfig] = None,
) -> StopAssessmentResponse

Stops the assessment of an on-premises environment.

Parameters:

Raises:

Source code in docs_src/capo_migrationhubstrategy/_services/migration_hub_strategy.py
def stop_assessment(
    self,
    assessment_id: "capo_migrationhubstrategy.types.async_task_id.AsyncTaskId",
    *,
    config_overrides: Optional[MigrationHubStrategyClientConfig] = None,
) -> "capo_migrationhubstrategy.types.stop_assessment_response.StopAssessmentResponse":
    """<p> Stops the assessment of an on-premises environment. </p>

    Args:
        assessment_id: <p> The <code>assessmentId</code> returned by <a>StartAssessment</a>. </p>

    Raises:
        capo_migrationhubstrategy.errors.access_denied_exception.AccessDeniedException: <p> The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.</p>
        capo_migrationhubstrategy.errors.internal_server_exception.InternalServerException: <p> The server experienced an internal error. Try again. </p>
        capo_migrationhubstrategy.errors.throttling_exception.ThrottlingException: <p> The request was denied due to request throttling. </p>
        capo_migrationhubstrategy.errors.validation_exception.ValidationException: <p> The request body isn't valid. </p>
        capo_migrationhubstrategy.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_migrationhubstrategy.types.stop_assessment_request.StopAssessmentRequest]",
    ) -> OperationResponse[
        "capo_migrationhubstrategy.types.stop_assessment_response.StopAssessmentResponse"
    ]:
        import capo_migrationhubstrategy._operations.aws_migration_hub_strategy_recommendation.stop_assessment

        output, http_response = (
            capo_migrationhubstrategy._operations.aws_migration_hub_strategy_recommendation.stop_assessment.stop_assessment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopAssessment")
    )
    input_: capo_migrationhubstrategy.types.stop_assessment_request.StopAssessmentRequest = {
        "assessment_id": assessment_id
    }

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