schema_versions

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

Overview

Name	schema_versions
Type	Resource
Id	aws.schemas.schema_versions

Fields

The following fields are returned by SELECT queries:

list_schema_versions

Name	Datatype	Description
schema_arn	string	The ARN of the schema version.
schema_name	string	The name of the schema.
schema_version	string	The version number of the schema.
type	string	The type of schema. (OpenApi3, JSONSchemaDraft4)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_schema_versions	select	registry_name, schema_name, region	limit, nextToken	Provides a list of the schema versions and related information.
delete_schema_version	delete	registry_name, schema_name, schema_version, region		Delete the schema version definition

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
region	string	AWS region (default: us-east-1)
registry_name	string	The name of the registry.
schema_name	string	The name of the schema.
schema_version	string	The version number of the schema
limit	integer
nextToken	string	The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

SELECT examples

list_schema_versions

Provides a list of the schema versions and related information.

SELECT
schema_arn,
schema_name,
schema_version,
type
FROM aws.schemas.schema_versions
WHERE registry_name = '{{ registry_name }}' -- required
AND schema_name = '{{ schema_name }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND nextToken = '{{ nextToken }}'
;

DELETE examples

delete_schema_version

Delete the schema version definition

DELETE FROM aws.schemas.schema_versions
WHERE registry_name = '{{ registry_name }}' --required
AND schema_name = '{{ schema_name }}' --required
AND schema_version = '{{ schema_version }}' --required
AND region = '{{ region }}' --required
;