recommender_schemas

Creates, updates, deletes, gets or lists a recommender_schemas resource.

Overview

Name	recommender_schemas
Type	Resource
Id	aws.customer_profiles.recommender_schemas

Fields

The following fields are returned by SELECT queries:

get_recommender_schema

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when the recommender schema was created.
fields	object	A map of dataset type to column definitions included in the schema.
recommender_schema_name	string	The name of the recommender schema. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
status	string	The status of the recommender schema. (ACTIVE, DELETING)

list_recommender_schemas

Name	Datatype	Description
created_at	string (date-time)	The timestamp when the recommender schema was created.
fields	object	A map of dataset type to column definitions included in the schema.
recommender_schema_name	string	The name of the recommender schema. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
status	string	The current operational status of the recommender schema. (ACTIVE, DELETING)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_recommender_schema	select	domain_name, recommender_schema_name, region		Retrieves information about a specific recommender schema in a domain.
list_recommender_schemas	select	domain_name, region	max-results, next-token	Returns a list of recommender schemas in the specified domain.
create_recommender_schema	insert	domain_name, recommender_schema_name, region		Creates a recommender schema. A recommender schema defines the set of data columns available for training recommenders and filters under a domain.
delete_recommender_schema	delete	domain_name, recommender_schema_name, region		Deletes a recommender schema from a domain.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_name	string	The unique name of the domain.
recommender_schema_name	string	The name of the recommender schema to delete.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of recommender schemas to return in the response. The default value is 100.
next-token	string	A token received from a previous ListRecommenderSchemas call to retrieve the next page of results.

SELECT examples

get_recommender_schema

Retrieves information about a specific recommender schema in a domain.

SELECT
created_at,
fields,
recommender_schema_name,
status
FROM aws.customer_profiles.recommender_schemas
WHERE domain_name = '{{ domain_name }}' -- required
AND recommender_schema_name = '{{ recommender_schema_name }}' -- required
AND region = '{{ region }}' -- required
;

list_recommender_schemas

Returns a list of recommender schemas in the specified domain.

SELECT
created_at,
fields,
recommender_schema_name,
status
FROM aws.customer_profiles.recommender_schemas
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;

INSERT examples

create_recommender_schema

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

INSERT INTO aws.customer_profiles.recommender_schemas (
Fields,
Tags,
domain_name,
recommender_schema_name,
region
)
SELECT 
'{{ Fields }}',
'{{ Tags }}',
'{{ domain_name }}',
'{{ recommender_schema_name }}',
'{{ region }}'
RETURNING
created_at,
fields,
recommender_schema_arn,
recommender_schema_name,
status,
tags
;

Manifest

# Description fields are for documentation purposes
- name: recommender_schemas
props:
  - name: domain_name
    value: "{{ domain_name }}"
    description: Required parameter for the recommender_schemas resource.
  - name: recommender_schema_name
    value: "{{ recommender_schema_name }}"
    description: Required parameter for the recommender_schemas resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the recommender_schemas resource.
  - name: Fields
    value: "{{ Fields }}"
  - name: Tags
    value: "{{ Tags }}"

DELETE examples

delete_recommender_schema

Deletes a recommender schema from a domain.

DELETE FROM aws.customer_profiles.recommender_schemas
WHERE domain_name = '{{ domain_name }}' --required
AND recommender_schema_name = '{{ recommender_schema_name }}' --required
AND region = '{{ region }}' --required
;