Update Batch Job
Path parameters
The Account Id
The Batch Job Id
Request body
Human-readable display name of the batch job. e.g. "My Batch Job" Must be fewer than 64 characters long.
The creation time of the batch job.
The time when the batch job started running.
The time when the batch job completed, failed, or was cancelled.
The email address of the user who created this batch job.
The ID of the environment that this batch job should use. e.g. my-env If specified, image_ref must not be specified.
The ID of the snapshot used by this batch job. If specified, environment_id must be specified and image_ref must not be specified.
For GPU node pools: one GPU per rank w/ host packing, for CPU node pools: one host per rank.
Environment variables to be passed during this job's execution.
The ARN of the AWS IAM role that the batch job should assume. If not specified, the connection will fall back to the node pool's node_role.
The container image used by this job. If specified, environment_id and snapshot_id must not be specified.
Arbitrary, user-specified metadata. Keys and values must adhere to Kubernetes constraints: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set Additionally, the "fireworks.ai/" prefix is reserved.
- CREATING: The batch job is being created.
- QUEUED: The batch job is in the queue and waiting to be scheduled. Currently unused.
- PENDING: The batch job scheduled and is waiting for resource allocation.
- RUNNING: The batch job is running.
- COMPLETED: The batch job has finished successfully.
- FAILED: The batch job has failed.
- CANCELLING: The batch job is being cancelled.
- CANCELLED: The batch job was cancelled.
- DELETING: The batch job is being deleted.
Detailed information about the current status of the batch job.
Whether the batch job is shared with all users in the account. This allows all users to update, delete, clone, and create environments using the batch job.
The update time for the batch job.
Response
A successful response.
Human-readable display name of the batch job. e.g. "My Batch Job" Must be fewer than 64 characters long.
The creation time of the batch job.
The time when the batch job started running.
The time when the batch job completed, failed, or was cancelled.
The email address of the user who created this batch job.
The ID of the environment that this batch job should use. e.g. my-env If specified, image_ref must not be specified.
The ID of the snapshot used by this batch job. If specified, environment_id must be specified and image_ref must not be specified.
For GPU node pools: one GPU per rank w/ host packing, for CPU node pools: one host per rank.
Environment variables to be passed during this job's execution.
The ARN of the AWS IAM role that the batch job should assume. If not specified, the connection will fall back to the node pool's node_role.
The container image used by this job. If specified, environment_id and snapshot_id must not be specified.
Arbitrary, user-specified metadata. Keys and values must adhere to Kubernetes constraints: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set Additionally, the "fireworks.ai/" prefix is reserved.
- CREATING: The batch job is being created.
- QUEUED: The batch job is in the queue and waiting to be scheduled. Currently unused.
- PENDING: The batch job scheduled and is waiting for resource allocation.
- RUNNING: The batch job is running.
- COMPLETED: The batch job has finished successfully.
- FAILED: The batch job has failed.
- CANCELLING: The batch job is being cancelled.
- CANCELLED: The batch job was cancelled.
- DELETING: The batch job is being deleted.
Detailed information about the current status of the batch job.
Whether the batch job is shared with all users in the account. This allows all users to update, delete, clone, and create environments using the batch job.
The update time for the batch job.