DescribeJob
Returns detailed information about a job, including its current status, secondary status, configuration, and timestamps. Use SecondaryStatus for granular progress tracking and SecondaryStatusTransitions to see the full history of status changes with timestamps.
The following operations are related to DescribeJob:
-
CreateJob -
ListJobs -
StopJob -
DeleteJob
Request Syntax
{
"JobCategory": "string",
"JobName": "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.
Type: String
Valid Values:
AgentRFT | AgentRFTEvaluationRequired: Yes
- JobName
-
The name of the job to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}Required: Yes
Response Syntax
{
"CreationTime": number,
"EndTime": number,
"FailureReason": "string",
"JobCategory": "string",
"JobConfigDocument": "string",
"JobConfigSchemaVersion": "string",
"JobName": "string",
"JobStatus": "string",
"LastModifiedTime": number,
"RoleArn": "string",
"SecondaryStatus": "string",
"SecondaryStatusTransitions": [
{
"EndTime": number,
"StartTime": number,
"Status": "string",
"StatusMessage": "string"
}
],
"Tags": [
{
"Key": "string",
"Value": "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.
- CreationTime
-
The date and time that the job was created.
Type: Timestamp
- EndTime
-
The date and time that the job ended.
Type: Timestamp
- FailureReason
-
If the job failed, the reason it failed.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
- JobCategory
-
The category of the job.
Type: String
Valid Values:
AgentRFT | AgentRFTEvaluation - JobConfigDocument
-
The JSON configuration document for the job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 262144.
- JobConfigSchemaVersion
-
The schema version used for the job configuration document.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 16.
Pattern:
\d+\.\d+\.\d+ - JobName
-
The name of the job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} - JobStatus
-
The current status of the job.
Type: String
Valid Values:
InProgress | Completed | Failed | Stopping | Stopped | Deleting | DeleteFailed - LastModifiedTime
-
The date and time that the job was last modified.
Type: Timestamp
- RoleArn
-
The ARN of the IAM role associated with the job.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ - SecondaryStatus
-
The detailed secondary status of the job, providing more granular information about the job's progress. Secondary statuses may change between releases.
Type: String
Valid Values:
Starting | Downloading | Training | Uploading | Stopping | Stopped | MaxRuntimeExceeded | Interrupted | Failed | Completed | Restarting | Pending | Evaluating | Deleting | DeleteFailed - SecondaryStatusTransitions
-
A list of secondary status transitions for the job, with timestamps and optional status messages.
Type: Array of JobSecondaryStatusTransition objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
- Tags
-
The tags associated with the job.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
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:
