SageMaker / Client / list_job_schema_versions

list_job_schema_versions¶

SageMaker.Client.list_job_schema_versions(**kwargs)¶

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

Request Syntax

response = client.list_job_schema_versions(
    JobCategory='AgentRFT'|'AgentRFTEvaluation',
    NextToken='string',
    MaxResults=123
)

Parameters:

JobCategory (string) –
[REQUIRED]

The category of job schemas to list.
NextToken (string) – If the previous response was truncated, this token retrieves the next set of results.
MaxResults (integer) – The maximum number of schema versions to return in the response. The default value is 5.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'JobConfigSchemas': [
        {
            'JobConfigSchemaVersion': 'string'
        },
    ]
}

Response Structure

(dict) –
- NextToken (string) –
  
  If the response is truncated, this token retrieves the next set of results.
- JobConfigSchemas (list) –
  
  An array of JobConfigSchemaVersionSummary objects listing the available schema versions.
  - (dict) –
    
    Provides summary information about a job configuration schema version.
    - JobConfigSchemaVersion (string) –
      
      The version of the job configuration schema.

Exceptions

SageMaker.Client.exceptions.ResourceNotFound