schema_versions

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

Overview

Name	schema_versions
Type	Resource
Id	aws.iot_managed_integrations.schema_versions

Fields

The following fields are returned by SELECT queries:

get_schema_version

Name	Datatype	Description
description	string	The description of the schema version. (pattern: <code>[a-zA-Z0-9.,/ -]+</code>)
namespace	string	The name of the schema version. (pattern: <code>[a-z0-9]+</code>)
schema	object	The schema of the schema version.
schema_id	string	The id of the schema version. (pattern: <code>[a-zA-Z0-9.]+</code>)
semantic_version	string	The schema version. If this is left blank, it defaults to the latest version. (pattern: <code>(\d+.\d+(.\d+)?|$latest)</code>)
type	string	The type of schema version. (capability, definition)
visibility	string	The visibility of the schema version. (PUBLIC, PRIVATE)

list_schema_versions

Name	Datatype	Description
description	string	A description of the schema version. (pattern: <code>[a-zA-Z0-9.,/ -]+</code>)
namespace	string	The name of the schema version. (pattern: <code>[a-z0-9]+</code>)
schema_id	string	The identifier of the schema version. (pattern: <code>[a-zA-Z0-9.]+</code>)
semantic_version	string	The schema version. If this is left blank, it defaults to the latest version. (pattern: <code>(\d+.\d+(.\d+)?|$latest)</code>)
type	string	The type of schema version. (capability, definition)
visibility	string	The visibility of the schema version. (PUBLIC, PRIVATE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_schema_version	select	type, schema_versioned_id, region	Format	Gets a schema version with the provided information.
list_schema_versions	select	type, region	MaxResults, NextToken, SchemaIdFilter, NamespaceFilter, VisibilityFilter, SemanticVersionFilter	Lists schema versions with the provided information.

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)
schema_versioned_id	string	Schema id with a version specified. If the version is missing, it defaults to latest version.
type	string	Filter on the type of schema version.
Format	string	The format of the schema version.
MaxResults	integer	The maximum number of results to return at one time.
NamespaceFilter	string	Filter on the name of the schema version.
NextToken	string	A token that can be used to retrieve the next set of results.
SchemaIdFilter	string	Filter on the id of the schema version.
SemanticVersionFilter	string	The schema version. If this is left blank, it defaults to the latest version.
VisibilityFilter	string	The visibility of the schema version.

SELECT examples

get_schema_version

Gets a schema version with the provided information.

SELECT
description,
namespace,
schema,
schema_id,
semantic_version,
type,
visibility
FROM aws.iot_managed_integrations.schema_versions
WHERE type = '{{ type }}' -- required
AND schema_versioned_id = '{{ schema_versioned_id }}' -- required
AND region = '{{ region }}' -- required
AND Format = '{{ Format }}'
;

list_schema_versions

Lists schema versions with the provided information.

SELECT
description,
namespace,
schema_id,
semantic_version,
type,
visibility
FROM aws.iot_managed_integrations.schema_versions
WHERE type = '{{ type }}' -- required
AND region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND SchemaIdFilter = '{{ SchemaIdFilter }}'
AND NamespaceFilter = '{{ NamespaceFilter }}'
AND VisibilityFilter = '{{ VisibilityFilter }}'
AND SemanticVersionFilter = '{{ SemanticVersionFilter }}'
;