update_model ¶

update_model(
    model_id: modelIdentifier,
    model_type: ModelTypeEnum,
    *,
    config_overrides: Optional[FraudDetectorClientConfig] = None,
    description: Optional[description] = None,
) -> UpdateModelResult

Updates model description.

Parameters:

model_id (modelIdentifier) –

The model ID.
model_type (ModelTypeEnum) –

The model type.
description (Optional[description], default: None ) –

The new model description.

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/fraud_detector.py

def update_model(
    self,
    model_id: "capo_frauddetector.types.model_identifier.modelIdentifier",
    model_type: "capo_frauddetector.types.model_type_enum.ModelTypeEnum",
    *,
    config_overrides: Optional[FraudDetectorClientConfig] = None,
    description: Optional[
        "capo_frauddetector.types.description.description"
    ] = None,
) -> "capo_frauddetector.types.update_model_result.UpdateModelResult":
    """<p>Updates model description.</p>

    Args:
        model_id: <p>The model ID.</p>
        model_type: <p>The model type.</p>
        description: <p>The new model description.</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.
    """

    def _handler(
        req: "OperationRequest[capo_frauddetector.types.update_model_request.UpdateModelRequest]",
    ) -> OperationResponse[
        "capo_frauddetector.types.update_model_result.UpdateModelResult"
    ]:
        import capo_frauddetector._operations.aws_hawks_nest_service_facade.update_model

        output, http_response = (
            capo_frauddetector._operations.aws_hawks_nest_service_facade.update_model.update_model(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateModel")
    )
    input_: capo_frauddetector.types.update_model_request.UpdateModelRequest = {
        "model_id": model_id,
        "model_type": model_type,
    }
    if description is not None:
        input_["description"] = description

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