update_detector_version_metadata `async` ¶

update_detector_version_metadata(
    detector_id: identifier,
    detector_version_id: wholeNumberVersionString,
    description: description,
    *,
    config_overrides: Optional[AsyncFraudDetectorClientConfig] = None,
) -> UpdateDetectorVersionMetadataResult

Updates the detector version's description. You can update the metadata for any detector version (DRAFT, ACTIVE, or INACTIVE).

Parameters:

detector_id (identifier) –

The detector ID.
detector_version_id (wholeNumberVersionString) –

The detector version ID.
description (description) –

The 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.
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_detector_version_metadata(
    self,
    detector_id: "capo_frauddetector.types.identifier.identifier",
    detector_version_id: "capo_frauddetector.types.whole_number_version_string.wholeNumberVersionString",
    description: "capo_frauddetector.types.description.description",
    *,
    config_overrides: Optional[AsyncFraudDetectorClientConfig] = None,
) -> "capo_frauddetector.types.update_detector_version_metadata_result.UpdateDetectorVersionMetadataResult":
    """<p>Updates the detector version's description. You can update the metadata for any detector version (<code>DRAFT, ACTIVE,</code> or <code>INACTIVE</code>). </p>

    Args:
        detector_id: <p>The detector ID.</p>
        detector_version_id: <p>The detector version ID. </p>
        description: <p>The 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.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_detector_version_metadata_request.UpdateDetectorVersionMetadataRequest]",
    ) -> AsyncOperationResponse[
        "capo_frauddetector.types.update_detector_version_metadata_result.UpdateDetectorVersionMetadataResult"
    ]:
        import capo_frauddetector._operations.aws_hawks_nest_service_facade.update_detector_version_metadata

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateDetectorVersionMetadata")
    )
    input_: capo_frauddetector.types.update_detector_version_metadata_request.UpdateDetectorVersionMetadataRequest = {
        "detector_id": detector_id,
        "detector_version_id": detector_version_id,
        "description": description,
    }

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

update_detector_version_metadata async ¶

update_detector_version_metadata `async` ¶