Skip to content

Returns the JSON schema for a specified job category and schema version

Description

Returns the JSON schema for a specified job category and schema version. Use this schema to validate your JobConfigDocument before calling create_job. 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 describe_job_schema_version:

Usage

sagemaker_describe_job_schema_version(JobCategory,
  JobConfigSchemaVersion)

Arguments

  • JobCategory

[required] The category of the job schema to describe.

  • JobConfigSchemaVersion

The version of the schema to retrieve. If not specified, the latest version is returned.

Value

A list with the following syntax:

list(
  JobCategory = "AgentRFT"|"AgentRFTEvaluation",
  JobConfigSchemaVersion = "string",
  JobConfigSchema = "string"
)

Request syntax

svc$describe_job_schema_version(
  JobCategory = "AgentRFT"|"AgentRFTEvaluation",
  JobConfigSchemaVersion = "string"
)