schemas

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

Overview

Name	schemas
Type	Resource
Description	Resource schema for AWS::Personalize::Schema.
Id	awscc.personalize.schemas

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	schemas	INSERT	Name, Schema, region
delete_resource	schemas	DELETE	Identifier, region
list_resources	schemas_list_only	SELECT	region
get_resource	schemas	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.schemas
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ schema_arn }}';

list (identifiers only)

Lists all schemas in a region.

SELECT
  region,
  schema_arn
FROM awscc.personalize.schemas_list_only
WHERE
  region = '{{ region }}';

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.schemas (
  Name,
  Schema,
  region
)
SELECT
  '{{ name }}',
  '{{ schema }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.personalize.schemas (
  Name,
  Schema,
  Domain,
  region
)
SELECT
  '{{ name }}',
  '{{ schema }}',
  '{{ domain }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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.schemas
WHERE
  Identifier = '{{ schema_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

personalize:CreateSchema,
personalize:DescribeSchema

Read

personalize:DescribeSchema

Delete

personalize:DeleteSchema,
personalize:DescribeSchema

List

personalize:ListSchemas