job_schema_versions

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

Overview

Name	job_schema_versions
Type	Resource
Id	aws.sagemaker.job_schema_versions

Fields

The following fields are returned by SELECT queries:

list_job_schema_versions

Name	Datatype	Description
job_config_schema_version	string	The version of the job configuration schema. (pattern: <code>\d+.\d+.\d+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_job_schema_versions	select	region		Lists available configuration schema versions for a specified job category. Use the schema versions with DescribeJobSchemaVersion to retrieve the full schema document. The following operations are related to ListJobSchemaVersions: DescribeJobSchemaVersion CreateJob
describe_job_schema_version	exec	region, JobCategory		Returns the JSON schema for a specified job category and schema version. Use this schema to validate your JobConfigDocument before calling CreateJob. If you don't specify a schema version, the latest version is returned. The schema defines required fields, allowed values, and constraints for the job configuration. The following operations are related to DescribeJobSchemaVersion: ListJobSchemaVersions CreateJob

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)

SELECT examples

list_job_schema_versions

Lists available configuration schema versions for a specified job category. Use the schema versions with DescribeJobSchemaVersion to retrieve the full schema document. The following operations are related to ListJobSchemaVersions: DescribeJobSchemaVersion CreateJob

SELECT
job_config_schema_version
FROM aws.sagemaker.job_schema_versions
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

describe_job_schema_version

Returns the JSON schema for a specified job category and schema version. Use this schema to validate your JobConfigDocument before calling CreateJob. If you don't specify a schema version, the latest version is returned. The schema defines required fields, allowed values, and constraints for the job configuration. The following operations are related to DescribeJobSchemaVersion: ListJobSchemaVersions CreateJob

EXEC aws.sagemaker.job_schema_versions.describe_job_schema_version 
@region='{{ region }}' --required 
@@json=
'{
"JobCategory": "{{ JobCategory }}", 
"JobConfigSchemaVersion": "{{ JobConfigSchemaVersion }}"
}'
;