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	awscc.personalize.schemata

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
schema_arn	string	Arn for the schema.
schema	string	A schema in Avro JSON format.
region	string	AWS region.

For more information, see AWS::Personalize::Schema.

Methods

Name	Resource	Accessible by	Required Params
create_resource	schemata	INSERT	Name, Schema, region
delete_resource	schemata	DELETE	Identifier, region
list_resources	schemata_list_only	SELECT	region
get_resource	schemata	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual schema.

SELECT
  region,
  name,
  schema_arn,
  schema,
  domain
FROM awscc.personalize.schemata
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ schema_arn }}';

list (identifiers only)

Lists all schemata in a region.

SELECT
  region,
  schema_arn
FROM awscc.personalize.schemata_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.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 awscc.personalize.schemata
WHERE
  Identifier = '{{ schema_arn }}' 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