DescribeJobSchemaVersion
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
Request Syntax
{
"JobCategory": "string",
"JobConfigSchemaVersion": "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 the job schema to describe.
Type: String
Valid Values:
AgentRFT | AgentRFTEvaluationRequired: Yes
- JobConfigSchemaVersion
-
The version of the schema to retrieve. If not specified, the latest version is returned.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 16.
Pattern:
\d+\.\d+\.\d+Required: No
Response Syntax
{
"JobCategory": "string",
"JobConfigSchema": "string",
"JobConfigSchemaVersion": "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.
- JobCategory
-
The category of the job schema.
Type: String
Valid Values:
AgentRFT | AgentRFTEvaluation - JobConfigSchema
-
The JSON schema document that defines the structure of the job configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 262144.
- JobConfigSchemaVersion
-
The version of the schema.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 16.
Pattern:
\d+\.\d+\.\d+
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:
