JobSummary
A summary of job details.
Contents
- createdAt
-
The date and time the resource was created.
Type: Timestamp
Required: Yes
- createdBy
-
The user or system that created this resource.
Type: String
Required: Yes
- jobId
-
The job ID.
Type: String
Pattern:
job-[0-9a-f]{32}Required: Yes
- lifecycleStatus
-
The life cycle status.
Type: String
Valid Values:
CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | UPLOAD_IN_PROGRESS | UPLOAD_FAILED | UPDATE_IN_PROGRESS | UPDATE_FAILED | UPDATE_SUCCEEDED | ARCHIVEDRequired: Yes
- lifecycleStatusMessage
-
The life cycle status message.
Type: String
Required: Yes
- name
-
The job name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
- priority
-
The job priority.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: Yes
- endedAt
-
The date and time the resource ended running.
Type: Timestamp
Required: No
- maxFailedTasksCount
-
The number of task failures before the job stops running and is marked as
FAILED.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 2147483647.
Required: No
- maxRetriesPerTask
-
The maximum number of retries for a job.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 2147483647.
Required: No
- maxWorkerCount
-
The maximum number of worker hosts that can concurrently process a job. When the
maxWorkerCountis reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.You can't set the
maxWorkerCountto 0. If you set it to -1, there is no maximum number of workers.If you don't specify the
maxWorkerCount, the default is -1.Type: Integer
Valid Range: Minimum value of -1. Maximum value of 2147483647.
Required: No
- sourceJobId
-
The job ID for the source job.
Type: String
Pattern:
job-[0-9a-f]{32}Required: No
- startedAt
-
The date and time the resource started running.
Type: Timestamp
Required: No
- targetTaskRunStatus
-
The task status to start with on the job.
Type: String
Valid Values:
READY | FAILED | SUCCEEDED | CANCELED | SUSPENDED | PENDINGRequired: No
- taskRunStatus
-
The task run status for the job.
-
PENDING–pending and waiting for resources. -
READY–ready to be processed. -
ASSIGNED–assigned and will run next on a worker. -
SCHEDULED–scheduled to be run on a worker. -
INTERRUPTING–being interrupted. -
RUNNING–running on a worker. -
SUSPENDED–the task is suspended. -
CANCELED–the task has been canceled. -
FAILED–the task has failed. -
SUCCEEDED–the task has succeeded.
Type: String
Valid Values:
PENDING | READY | ASSIGNED | STARTING | SCHEDULED | INTERRUPTING | RUNNING | SUSPENDED | CANCELED | FAILED | SUCCEEDED | NOT_COMPATIBLERequired: No
-
- taskRunStatusCounts
-
The number of tasks running on the job.
Type: String to integer map
Valid Keys:
PENDING | READY | ASSIGNED | STARTING | SCHEDULED | INTERRUPTING | RUNNING | SUSPENDED | CANCELED | FAILED | SUCCEEDED | NOT_COMPATIBLERequired: No
- updatedAt
-
The date and time the resource was updated.
Type: Timestamp
Required: No
- updatedBy
-
The user or system that updated this resource.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
