create_filter async ¶

async def create_filter(
    self,
    name: "capo_personalize.types.name.Name",
    dataset_group_arn: "capo_personalize.types.arn.Arn",
    filter_expression: "capo_personalize.types.filter_expression.FilterExpression",
    *,
    config_overrides: Optional[AsyncPersonalizeClientConfig] = None,
    tags: Optional["capo_personalize.types.tags.Tags"] = None,
) -> "capo_personalize.types.create_filter_response.CreateFilterResponse":
    """<p>Creates a recommendation filter. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering recommendations and user segments</a>.</p>

    Args:
        name: <p>The name of the filter to create.</p>
        dataset_group_arn: <p>The ARN of the dataset group that the filter will belong to.</p>
        filter_expression: <p>The filter expression defines which items are included or excluded from recommendations. Filter expression must follow specific format rules. For information about filter expression structure and syntax, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html">Filter expressions</a>.</p>
        tags: <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the filter.</p>

    Raises:
        capo_personalize.errors.invalid_input_exception.InvalidInputException: <p>Provide a valid value for the field or parameter.</p>
        capo_personalize.errors.limit_exceeded_exception.LimitExceededException: <p>The limit on the number of requests per second has been exceeded.</p>
        capo_personalize.errors.resource_already_exists_exception.ResourceAlreadyExistsException: <p>The specified resource already exists.</p>
        capo_personalize.errors.resource_not_found_exception.ResourceNotFoundException: <p>Could not find the specified resource.</p>
        capo_personalize.errors.too_many_tags_exception.TooManyTagsException: <p>You have exceeded the maximum number of tags you can apply to this resource. </p>
        capo_personalize.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_personalize.types.create_filter_request.CreateFilterRequest]",
    ) -> AsyncOperationResponse[
        "capo_personalize.types.create_filter_response.CreateFilterResponse"
    ]:
        import capo_personalize._operations.amazon_personalize.create_filter

        (
            output,
            http_response,
        ) = await capo_personalize._operations.amazon_personalize.create_filter.async_create_filter(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_personalize.types.create_filter_request.CreateFilterRequest",
    ) -> dict[str, Any]:
        import capo_personalize.types.create_filter_request

        return capo_personalize.types.create_filter_request.redact_sensitive(input_)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateFilter", redact_input=_redact_input),
    )
    input_: capo_personalize.types.create_filter_request.CreateFilterRequest = {
        "name": name,
        "dataset_group_arn": dataset_group_arn,
        "filter_expression": filter_expression,
    }
    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