SageMaker / Client / describe_job_schema_version

describe_job_schema_version

SageMaker.Client.describe_job_schema_version(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_job_schema_version(
    JobCategory='AgentRFT'|'AgentRFTEvaluation',
    JobConfigSchemaVersion='string'
)
Parameters:

  • JobCategory (string) –

    [REQUIRED]

    The category of the job schema to describe.

  • JobConfigSchemaVersion (string) – The version of the schema to retrieve. If not specified, the latest version is returned.

Return type:

dict

Returns:

Response Syntax

{
    'JobCategory': 'AgentRFT'|'AgentRFTEvaluation',
    'JobConfigSchemaVersion': 'string',
    'JobConfigSchema': 'string'
}

Response Structure

  • (dict) –

    • JobCategory (string) –

      The category of the job schema.

    • JobConfigSchemaVersion (string) –

      The version of the schema.

    • JobConfigSchema (string) –

      The JSON schema document that defines the structure of the job configuration.

Exceptions