BatchUpdateJobItem
The details of a job to update in a batch update operation.
Contents
- farmId
-
The farm ID of the job to update.
Type: String
Pattern:
farm-[0-9a-f]{32}Required: Yes
- jobId
-
The job ID of the job to update.
Type: String
Pattern:
job-[0-9a-f]{32}Required: Yes
- queueId
-
The queue ID of the job to update.
Type: String
Pattern:
queue-[0-9a-f]{32}Required: Yes
- description
-
The description of the job to update.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
- lifecycleStatus
-
The status of a job in its lifecycle. When you change the status of the job to
ARCHIVED, the job can't be scheduled or archived.Important
An archived job and its steps and tasks are deleted after 120 days. The job can't be recovered.
Type: String
Valid Values:
ARCHIVEDRequired: 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 per failed tasks.
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.
Type: Integer
Valid Range: Minimum value of -1. Maximum value of 2147483647.
Required: No
- name
-
The name of the job to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
- priority
-
The job priority to update.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
- targetTaskRunStatus
-
The task status to update the job's tasks to.
Type: String
Valid Values:
READY | FAILED | SUCCEEDED | CANCELED | SUSPENDED | PENDINGRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
