create_recommender_schema ¶

create_recommender_schema(
    domain_name: name,
    recommender_schema_name: name,
    fields: RecommenderSchemaFields,
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
    tags: Optional[TagMap] = None,
) -> CreateRecommenderSchemaResponse

Creates a recommender schema. A recommender schema defines the set of data columns available for training recommenders and filters under a domain.

Parameters:

domain_name (name) –

The unique name of the domain.
recommender_schema_name (name) –

The name of the recommender schema. The name must be unique within the domain.
fields (RecommenderSchemaFields) –

A map of dataset type to column definitions that specifies which data columns to include in the schema. The _webAnalytics and _catalogItem keys are supported.
tags (Optional[TagMap], default: None ) –

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

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
BadRequestException –

The input you provided is invalid.
InternalServerException –

An internal service error occurred.
ResourceNotFoundException –

The requested resource does not exist, or access was denied.
ThrottlingException –

You exceeded the maximum number of requests.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_customer_profiles/_services/customer_profiles.py

def create_recommender_schema(
    self,
    domain_name: "capo_customer_profiles.types.name.name",
    recommender_schema_name: "capo_customer_profiles.types.name.name",
    fields: "capo_customer_profiles.types.recommender_schema_fields.RecommenderSchemaFields",
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
    tags: Optional["capo_customer_profiles.types.tag_map.TagMap"] = None,
) -> "capo_customer_profiles.types.create_recommender_schema_response.CreateRecommenderSchemaResponse":
    """<p>Creates a recommender schema. A recommender schema defines the set of data columns available for training recommenders and filters under a domain.</p>

    Args:
        domain_name: <p>The unique name of the domain.</p>
        recommender_schema_name: <p>The name of the recommender schema. The name must be unique within the domain.</p>
        fields: <p>A map of dataset type to column definitions that specifies which data columns to include in the schema. The <code>_webAnalytics</code> and <code>_catalogItem</code> keys are supported.</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.
    """

    def _handler(
        req: "OperationRequest[capo_customer_profiles.types.create_recommender_schema_request.CreateRecommenderSchemaRequest]",
    ) -> OperationResponse[
        "capo_customer_profiles.types.create_recommender_schema_response.CreateRecommenderSchemaResponse"
    ]:
        import capo_customer_profiles._operations.customer_profiles_20200815.create_recommender_schema

        output, http_response = (
            capo_customer_profiles._operations.customer_profiles_20200815.create_recommender_schema.create_recommender_schema(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateRecommenderSchema")
    )
    input_: capo_customer_profiles.types.create_recommender_schema_request.CreateRecommenderSchemaRequest = {
        "domain_name": domain_name,
        "recommender_schema_name": recommender_schema_name,
        "fields": fields,
    }
    if tags is not None:
        input_["tags"] = tags

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output