schema_as_jsons

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

Overview

Name	schema_as_jsons
Type	Resource
Id	aws.clouddirectory.schema_as_jsons

Fields

The following fields are returned by SELECT queries:

get_schema_as_json

Name	Datatype	Description
document	string	The JSON representation of the schema document.
name	string	The name of the retrieved schema. (pattern: <code>^[a-zA-Z0-9._-]*$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_schema_as_json	select	x-amz-data-partition, region		Retrieves a JSON representation of the schema. See JSON Schema Format for more 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)
x-amz-data-partition	string	The ARN of the schema to retrieve.

SELECT examples

get_schema_as_json

Retrieves a JSON representation of the schema. See JSON Schema Format for more information.

SELECT
document,
name
FROM aws.clouddirectory.schema_as_jsons
WHERE `x-amz-data-partition` = '{{ x-amz-data-partition }}' -- required
AND region = '{{ region }}' -- required
;