update_rule_metadata `async` ¶

update_rule_metadata(
    rule: Rule,
    description: description,
    *,
    config_overrides: Optional[AsyncFraudDetectorClientConfig] = None,
) -> UpdateRuleMetadataResult

Updates a rule's metadata. The description attribute can be updated.

Parameters:

rule (Rule) –

The rule to update.
description (description) –

The rule 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/async_fraud_detector.py

async def update_rule_metadata(
    self,
    rule: "capo_frauddetector.types.rule.Rule",
    description: "capo_frauddetector.types.description.description",
    *,
    config_overrides: Optional[AsyncFraudDetectorClientConfig] = None,
) -> (
    "capo_frauddetector.types.update_rule_metadata_result.UpdateRuleMetadataResult"
):
    """<p>Updates a rule's metadata. The description attribute can be updated.</p>

    Args:
        rule: <p>The rule to update.</p>
        description: <p>The rule 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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_frauddetector.types.update_rule_metadata_request.UpdateRuleMetadataRequest]",
    ) -> AsyncOperationResponse[
        "capo_frauddetector.types.update_rule_metadata_result.UpdateRuleMetadataResult"
    ]:
        import capo_frauddetector._operations.aws_hawks_nest_service_facade.update_rule_metadata

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateRuleMetadata")
    )
    input_: capo_frauddetector.types.update_rule_metadata_request.UpdateRuleMetadataRequest = {
        "rule": rule,
        "description": description,
    }

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

update_rule_metadata async ¶

update_rule_metadata `async` ¶