schemata

Creates, updates, deletes or gets a schema resource or lists schemata in a region

Overview

Name	schemata
Type	Resource
Description	Resource schema for AWS::Personalize::Schema.
Id	aws.personalize.schemata

Fields

Name	Datatype	Description
name	string	Name for the schema.
schema_arn	string	Arn for the schema.
schema	string	A schema in Avro JSON format.
domain	string	The domain of a Domain dataset group.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, Schema, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all schemata in a region.

SELECT
region,
name,
schema_arn,
schema,
domain
FROM aws.personalize.schemata
WHERE region = 'us-east-1';

Gets all properties from an individual schema.

SELECT
region,
name,
schema_arn,
schema,
domain
FROM aws.personalize.schemata
WHERE region = 'us-east-1' AND data__Identifier = '<SchemaArn>';

INSERT example

Use the following StackQL query and manifest file to create a new schema resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.personalize.schemata (
 Name,
 Schema,
 region
)
SELECT 
'{{ Name }}',
 '{{ Schema }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.personalize.schemata (
 Name,
 Schema,
 Domain,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Schema }}',
 '{{ Domain }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: schema
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Schema
        value: '{{ Schema }}'
      - name: Domain
        value: '{{ Domain }}'

DELETE example

/*+ delete */
DELETE FROM aws.personalize.schemata
WHERE data__Identifier = '<SchemaArn>'
AND region = 'us-east-1';

Permissions

To operate on the schemata resource, the following permissions are required:

Create

personalize:CreateSchema,
personalize:DescribeSchema

Read

personalize:DescribeSchema

Delete

personalize:DeleteSchema,
personalize:DescribeSchema

List

personalize:ListSchemas