put_label `async` ¶

put_label(
    name: identifier,
    *,
    config_overrides: Optional[AsyncFraudDetectorClientConfig] = None,
    description: Optional[description] = None,
    tags: Optional[tagList] = None,
) -> PutLabelResult

Creates or updates label. A label classifies an event as fraudulent or legitimate. Labels are associated with event types and used to train supervised machine learning models in Amazon Fraud Detector.

Parameters:

name (identifier) –

The label name.
description (Optional[description], default: None ) –

The label description.
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.
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 put_label(
    self,
    name: "capo_frauddetector.types.identifier.identifier",
    *,
    config_overrides: Optional[AsyncFraudDetectorClientConfig] = None,
    description: Optional[
        "capo_frauddetector.types.description.description"
    ] = None,
    tags: Optional["capo_frauddetector.types.tag_list.tagList"] = None,
) -> "capo_frauddetector.types.put_label_result.PutLabelResult":
    """<p>Creates or updates label. A label classifies an event as fraudulent or legitimate. Labels are associated with event types and used to train supervised machine learning models in Amazon Fraud Detector. </p>

    Args:
        name: <p>The label name.</p>
        description: <p>The label description.</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.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.put_label_request.PutLabelRequest]",
    ) -> AsyncOperationResponse[
        "capo_frauddetector.types.put_label_result.PutLabelResult"
    ]:
        import capo_frauddetector._operations.aws_hawks_nest_service_facade.put_label

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutLabel")
    )
    input_: capo_frauddetector.types.put_label_request.PutLabelRequest = {
        "name": name
    }
    if description is not None:
        input_["description"] = description
    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

put_label async ¶

put_label `async` ¶