start_assessment `async` ¶

start_assessment(
    *,
    config_overrides: Optional[AsyncMigrationHubStrategyClientConfig] = None,
    s3bucket_for_analysis_data: Optional[String] = None,
    s3bucket_for_report_data: Optional[String] = None,
    assessment_targets: Optional[AssessmentTargets] = None,
    assessment_data_source_type: Optional[AssessmentDataSourceType] = None,
) -> StartAssessmentResponse

Starts the assessment of an on-premises environment.

Parameters:

s3bucket_for_analysis_data (Optional[String], default: None ) –

The S3 bucket used by the collectors to send analysis data to the service. The bucket name must begin with migrationhub-strategy-.
s3bucket_for_report_data (Optional[String], default: None ) –

The S3 bucket where all the reports generated by the service are stored. The bucket name must begin with migrationhub-strategy-.
assessment_targets (Optional[AssessmentTargets], default: None ) –

List of criteria for assessment.
assessment_data_source_type (Optional[AssessmentDataSourceType], default: None ) –

The data source type of an assessment to be started.

Raises:

AccessDeniedException –

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.
InternalServerException –

The server experienced an internal error. Try again.
ServiceQuotaExceededException –

The AWS account has reached its quota of imports. Contact AWS Support to increase the quota for this account.
ThrottlingException –

The request was denied due to request throttling.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_migrationhubstrategy/_services/async_migration_hub_strategy.py

async def start_assessment(
    self,
    *,
    config_overrides: Optional[AsyncMigrationHubStrategyClientConfig] = None,
    s3bucket_for_analysis_data: Optional[
        "capo_migrationhubstrategy.types.string.String"
    ] = None,
    s3bucket_for_report_data: Optional[
        "capo_migrationhubstrategy.types.string.String"
    ] = None,
    assessment_targets: Optional[
        "capo_migrationhubstrategy.types.assessment_targets.AssessmentTargets"
    ] = None,
    assessment_data_source_type: Optional[
        "capo_migrationhubstrategy.types.assessment_data_source_type.AssessmentDataSourceType"
    ] = None,
) -> "capo_migrationhubstrategy.types.start_assessment_response.StartAssessmentResponse":
    """<p> Starts the assessment of an on-premises environment. </p>

    Args:
        s3bucket_for_analysis_data: <p> The S3 bucket used by the collectors to send analysis data to the service. The bucket name must begin with <code>migrationhub-strategy-</code>. </p>
        s3bucket_for_report_data: <p> The S3 bucket where all the reports generated by the service are stored. The bucket name must begin with <code>migrationhub-strategy-</code>. </p>
        assessment_targets: <p>List of criteria for assessment.</p>
        assessment_data_source_type: The data source type of an assessment to be started.

    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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p> The AWS account has reached its quota of imports. Contact AWS Support to increase the quota for this account. </p>
        capo_migrationhubstrategy.errors.throttling_exception.ThrottlingException: <p> The request was denied due to request throttling. </p>
        capo_migrationhubstrategy.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_migrationhubstrategy.types.start_assessment_request.StartAssessmentRequest]",
    ) -> AsyncOperationResponse[
        "capo_migrationhubstrategy.types.start_assessment_response.StartAssessmentResponse"
    ]:
        import capo_migrationhubstrategy._operations.aws_migration_hub_strategy_recommendation.start_assessment

        (
            output,
            http_response,
        ) = await capo_migrationhubstrategy._operations.aws_migration_hub_strategy_recommendation.start_assessment.async_start_assessment(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartAssessment")
    )
    input_: capo_migrationhubstrategy.types.start_assessment_request.StartAssessmentRequest = {}
    if s3bucket_for_analysis_data is not None:
        input_["s3bucket_for_analysis_data"] = s3bucket_for_analysis_data
    if s3bucket_for_report_data is not None:
        input_["s3bucket_for_report_data"] = s3bucket_for_report_data
    if assessment_targets is not None:
        input_["assessment_targets"] = assessment_targets
    if assessment_data_source_type is not None:
        input_["assessment_data_source_type"] = assessment_data_source_type

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

start_assessment async ¶

start_assessment `async` ¶