View a markdown version of this page

ListJobSchemaVersions - Amazon SageMaker

ListJobSchemaVersions

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

{ "JobCategory": "string", "MaxResults": number, "NextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

JobCategory

The category of job schemas to list.

Type: String

Valid Values: AgentRFT | AgentRFTEvaluation

Required: Yes

MaxResults

The maximum number of schema versions to return in the response. The default value is 5.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

If the previous response was truncated, this token retrieves the next set of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Required: No

Response Syntax

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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

JobConfigSchemas

An array of JobConfigSchemaVersionSummary objects listing the available schema versions.

Type: Array of JobConfigSchemaVersionSummary objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

NextToken

If the response is truncated, this token retrieves the next set of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Errors

For information about the errors that are common to all actions, see Common Error Types.

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: