Skip to content

create_recommender async

create_recommender(
    domain_name: name,
    recommender_name: name,
    recommender_recipe_name: RecommenderRecipeName,
    *,
    config_overrides: Optional[AsyncCustomerProfilesClientConfig] = None,
    recommender_config: Optional[RecommenderConfig] = None,
    description: Optional[sensitiveText] = None,
    recommender_schema_name: Optional[name] = None,
    tags: Optional[TagMap] = None,
) -> CreateRecommenderResponse

Creates a recommender

Parameters:

  • domain_name (name) –

    The unique name of the domain.

  • recommender_name (name) –

    The name of the recommender.

  • recommender_recipe_name (RecommenderRecipeName) –

    The name of the recommeder recipe.

  • recommender_config (Optional[RecommenderConfig], default: None ) –

    The recommender configuration.

  • description (Optional[sensitiveText], default: None ) –

    The description of the domain object type.

  • recommender_schema_name (Optional[name], default: None ) –

    The name of the recommender schema to use for this recommender. If not specified, the default schema is used.

  • tags (Optional[TagMap], default: None ) –

    The tags used to organize, track, or control access for this resource.

Raises:

Source code in docs_src/capo_customer_profiles/_services/async_customer_profiles.py
async def create_recommender(
    self,
    domain_name: "capo_customer_profiles.types.name.name",
    recommender_name: "capo_customer_profiles.types.name.name",
    recommender_recipe_name: "capo_customer_profiles.types.recommender_recipe_name.RecommenderRecipeName",
    *,
    config_overrides: Optional[AsyncCustomerProfilesClientConfig] = None,
    recommender_config: Optional[
        "capo_customer_profiles.types.recommender_config.RecommenderConfig"
    ] = None,
    description: Optional[
        "capo_customer_profiles.types.sensitive_text.sensitiveText"
    ] = None,
    recommender_schema_name: Optional[
        "capo_customer_profiles.types.name.name"
    ] = None,
    tags: Optional["capo_customer_profiles.types.tag_map.TagMap"] = None,
) -> "capo_customer_profiles.types.create_recommender_response.CreateRecommenderResponse":
    """<p>Creates a recommender</p>

    Args:
        domain_name: <p>The unique name of the domain.</p>
        recommender_name: <p>The name of the recommender.</p>
        recommender_recipe_name: <p>The name of the recommeder recipe.</p>
        recommender_config: <p>The recommender configuration.</p>
        description: <p>The description of the domain object type.</p>
        recommender_schema_name: <p>The name of the recommender schema to use for this recommender. If not specified, the default schema is used.</p>
        tags: <p>The tags used to organize, track, or control access for this resource.</p>

    Raises:
        capo_customer_profiles.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_customer_profiles.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
        capo_customer_profiles.errors.internal_server_exception.InternalServerException: <p>An internal service error occurred.</p>
        capo_customer_profiles.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource does not exist, or access was denied.</p>
        capo_customer_profiles.errors.throttling_exception.ThrottlingException: <p>You exceeded the maximum number of requests.</p>
        capo_customer_profiles.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_customer_profiles.types.create_recommender_request.CreateRecommenderRequest]",
    ) -> AsyncOperationResponse[
        "capo_customer_profiles.types.create_recommender_response.CreateRecommenderResponse"
    ]:
        import capo_customer_profiles._operations.customer_profiles_20200815.create_recommender

        (
            output,
            http_response,
        ) = await capo_customer_profiles._operations.customer_profiles_20200815.create_recommender.async_create_recommender(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_customer_profiles.types.create_recommender_request.CreateRecommenderRequest",
    ) -> dict[str, Any]:
        import capo_customer_profiles.types.create_recommender_request

        return capo_customer_profiles.types.create_recommender_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateRecommender", redact_input=_redact_input),
    )
    input_: capo_customer_profiles.types.create_recommender_request.CreateRecommenderRequest = {
        "domain_name": domain_name,
        "recommender_name": recommender_name,
        "recommender_recipe_name": recommender_recipe_name,
    }
    if recommender_config is not None:
        input_["recommender_config"] = recommender_config
    if description is not None:
        input_["description"] = description
    if recommender_schema_name is not None:
        input_["recommender_schema_name"] = recommender_schema_name
    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