Skip to content

update_model_version async

update_model_version(
    model_id: modelIdentifier,
    model_type: ModelTypeEnum,
    major_version_number: wholeNumberVersionString,
    *,
    config_overrides: Optional[AsyncFraudDetectorClientConfig] = None,
    external_events_detail: Optional[ExternalEventsDetail] = None,
    ingested_events_detail: Optional[IngestedEventsDetail] = None,
    tags: Optional[tagList] = None,
) -> UpdateModelVersionResult

Updates a model version. Updating a model version retrains an existing model version using updated training data and produces a new minor version of the model. You can update the training data set location and data access role attributes using this action. This action creates and trains a new minor version of the model, for example version 1.01, 1.02, 1.03.

Parameters:

  • model_id (modelIdentifier) –

    The model ID.

  • model_type (ModelTypeEnum) –

    The model type.

  • major_version_number (wholeNumberVersionString) –

    The major version number.

  • external_events_detail (Optional[ExternalEventsDetail], default: None ) –

    The details of the external events data used for training the model version. Required if trainingDataSource is EXTERNAL_EVENTS.

  • ingested_events_detail (Optional[IngestedEventsDetail], default: None ) –

    The details of the ingested event used for training the model version. Required if your trainingDataSource is INGESTED_EVENTS.

  • tags (Optional[tagList], default: None ) –

    A collection of key and value pairs.

Raises:

  • AccessDeniedException –

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

  • ConflictException –

    An exception indicating there was a conflict during a delete operation.

  • InternalServerException –

    An exception indicating an internal server error.

  • ResourceNotFoundException –

    An exception indicating the specified resource was not found.

  • ThrottlingException –

    An exception indicating a throttling error.

  • ValidationException –

    An exception indicating a specified value is not allowed.

  • UnknownServiceError –

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

Source code in docs_src/capo_frauddetector/_services/async_fraud_detector.py
async def update_model_version(
    self,
    model_id: "capo_frauddetector.types.model_identifier.modelIdentifier",
    model_type: "capo_frauddetector.types.model_type_enum.ModelTypeEnum",
    major_version_number: "capo_frauddetector.types.whole_number_version_string.wholeNumberVersionString",
    *,
    config_overrides: Optional[AsyncFraudDetectorClientConfig] = None,
    external_events_detail: Optional[
        "capo_frauddetector.types.external_events_detail.ExternalEventsDetail"
    ] = None,
    ingested_events_detail: Optional[
        "capo_frauddetector.types.ingested_events_detail.IngestedEventsDetail"
    ] = None,
    tags: Optional["capo_frauddetector.types.tag_list.tagList"] = None,
) -> (
    "capo_frauddetector.types.update_model_version_result.UpdateModelVersionResult"
):
    """<p>Updates a model version. Updating a model version retrains an existing model version using updated training data and produces a new minor version of the model. You can update the training data set location and data access role attributes using this action. This action creates and trains a new minor version of the model, for example version 1.01, 1.02, 1.03.</p>

    Args:
        model_id: <p>The model ID.</p>
        model_type: <p>The model type.</p>
        major_version_number: <p>The major version number.</p>
        external_events_detail: <p>The details of the external events data used for training the model version. Required if <code>trainingDataSource</code> is <code>EXTERNAL_EVENTS</code>.</p>
        ingested_events_detail: <p>The details of the ingested event used for training the model version. Required if your <code>trainingDataSource</code> is <code>INGESTED_EVENTS</code>.</p>
        tags: <p>A collection of key and value pairs.</p>

    Raises:
        capo_frauddetector.errors.access_denied_exception.AccessDeniedException: <p>An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as <code>PutExternalModel</code>, that specifies a role that is not in your account.</p>
        capo_frauddetector.errors.conflict_exception.ConflictException: <p>An exception indicating there was a conflict during a delete operation.</p>
        capo_frauddetector.errors.internal_server_exception.InternalServerException: <p>An exception indicating an internal server error.</p>
        capo_frauddetector.errors.resource_not_found_exception.ResourceNotFoundException: <p>An exception indicating the specified resource was not found.</p>
        capo_frauddetector.errors.throttling_exception.ThrottlingException: <p>An exception indicating a throttling error.</p>
        capo_frauddetector.errors.validation_exception.ValidationException: <p>An exception indicating a specified value is not allowed.</p>
        capo_frauddetector.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_frauddetector.types.update_model_version_request.UpdateModelVersionRequest]",
    ) -> AsyncOperationResponse[
        "capo_frauddetector.types.update_model_version_result.UpdateModelVersionResult"
    ]:
        import capo_frauddetector._operations.aws_hawks_nest_service_facade.update_model_version

        (
            output,
            http_response,
        ) = await capo_frauddetector._operations.aws_hawks_nest_service_facade.update_model_version.async_update_model_version(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateModelVersion")
    )
    input_: capo_frauddetector.types.update_model_version_request.UpdateModelVersionRequest = {
        "model_id": model_id,
        "model_type": model_type,
        "major_version_number": major_version_number,
    }
    if external_events_detail is not None:
        input_["external_events_detail"] = external_events_detail
    if ingested_events_detail is not None:
        input_["ingested_events_detail"] = ingested_events_detail
    if tags is not None:
        input_["tags"] = tags

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