Module Values.JobDetailSource

An object that represents an Batch job.

Sourcetype nonrec t = {
  1. jobArn : String_.t option;
    (*

    The Amazon Resource Name (ARN) of the job.

    *)
  2. jobName : String_.t option;
    (*

    The job name.

    *)
  3. jobId : String_.t option;
    (*

    The job ID.

    *)
  4. jobQueue : String_.t option;
    (*

    The Amazon Resource Name (ARN) of the job queue that the job is associated with.

    *)
  5. status : JobStatus.t option;
    (*

    The current status for the job. If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.

    *)
  6. shareIdentifier : String_.t option;
    (*

    The share identifier for the job.

    *)
  7. schedulingPriority : Integer.t option;
    (*

    The scheduling policy of the job definition. This only affects jobs in job queues with a fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

    *)
  8. attempts : AttemptDetails.t option;
    (*

    A list of job attempts that are associated with this job.

    *)
  9. statusReason : String_.t option;
    (*

    A short, human-readable string to provide more details for the current status of the job. CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY - All compute environments have insufficient capacity to service the job. MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE - All compute environments have a maxVcpu setting that is smaller than the job requirements. MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT - All compute environments have no connected instances that meet the job requirements. MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS - All compute environments have problems with the service role permissions.

    *)
  10. createdAt : Long.t option;
    (*

    The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state. This is specifically at the time SubmitJob was called. For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

    *)
  11. retryStrategy : RetryStrategy.t option;
    (*

    The retry strategy to use for this job if an attempt fails.

    *)
  12. startedAt : Long.t option;
    (*

    The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.

    *)
  13. stoppedAt : Long.t option;
    (*

    The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

    *)
  14. dependsOn : JobDependencyList.t option;
    (*

    A list of job IDs that this job depends on.

    *)
  15. jobDefinition : String_.t option;
    (*

    The Amazon Resource Name (ARN) of the job definition that this job uses.

    *)
  16. parameters : ParametersMap.t option;
    (*

    Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

    *)
  17. container : ContainerDetail.t option;
    (*

    An object that represents the details for the container that's associated with the job. If the details are for a multiple-container job, this object will be empty.

    *)
  18. nodeDetails : NodeDetails.t option;
    (*

    An object that represents the details of a node that's associated with a multi-node parallel job.

    *)
  19. nodeProperties : NodeProperties.t option;
    (*

    An object that represents the node properties of a multi-node parallel job. This isn't applicable to jobs that are running on Fargate resources.

    *)
  20. arrayProperties : ArrayPropertiesDetail.t option;
    (*

    The array properties of the job, if it's an array job.

    *)
  21. timeout : JobTimeout.t option;
    (*

    The timeout configuration for the job.

    *)
  22. tags : TagrisTagsMap.t option;
    (*

    The tags that are applied to the job.

    *)
  23. propagateTags : Boolean.t option;
    (*

    Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

    *)
  24. platformCapabilities : PlatformCapabilityList.t option;
    (*

    The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

    *)
  25. eksProperties : EksPropertiesDetail.t option;
    (*

    An object with various properties that are specific to Amazon EKS based jobs.

    *)
  26. eksAttempts : EksAttemptDetails.t option;
    (*

    A list of job attempts that are associated with this job.

    *)
  27. ecsProperties : EcsPropertiesDetail.t option;
    (*

    An object with properties that are specific to Amazon ECS-based jobs.

    *)
  28. isCancelled : Boolean.t option;
    (*

    Indicates whether the job is canceled.

    *)
  29. isTerminated : Boolean.t option;
    (*

    Indicates whether the job is terminated.

    *)
  30. consumableResourceProperties : ConsumableResourceProperties.t option;
    (*

    Contains a list of consumable resources required by the job.

    *)
}
Sourceval make : ?jobArn:??? -> ?jobName:??? -> ?jobId:??? -> ?jobQueue:??? -> ?status:??? -> ?shareIdentifier:??? -> ?schedulingPriority:??? -> ?attempts:??? -> ?statusReason:??? -> ?createdAt:??? -> ?retryStrategy:??? -> ?startedAt:??? -> ?stoppedAt:??? -> ?dependsOn:??? -> ?jobDefinition:??? -> ?parameters:??? -> ?container:??? -> ?nodeDetails:??? -> ?nodeProperties:??? -> ?arrayProperties:??? -> ?timeout:??? -> ?tags:??? -> ?propagateTags:??? -> ?platformCapabilities:??? -> ?eksProperties:??? -> ?eksAttempts:??? -> ?ecsProperties:??? -> ?isCancelled:??? -> ?isTerminated:??? -> ?consumableResourceProperties:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of Integer.t | `List of [> `Enum of string | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Integer of Integer.t | `List of [> `Structure of (string * [> `Integer of Integer.t | `List of [> `Structure of (string * [> `String of String_.t ]) list ] list | `String of String_.t ]) list ] list | `String of String_.t ]) list ] list | `Long of Long.t | `String of String_.t | `Structure of (string * [> `Integer of Integer.t | `List of [> `Structure of (string * [> `String of String_.t ]) list ] list | `String of String_.t ]) list ]) list ] list | `Long of Long.t | `Map of ([> `String of String_.t ] * [> `String of String_.t ]) list | `String of String_.t | `Structure of (string * [> `Boolean of Boolean.t | `Integer of Integer.t | `List of [> `String of String_.t | `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of Integer.t | `List of [> `String of String_.t | `Structure of (string * [> `Boolean of Boolean.t | `Integer of Integer.t | `List of [> `String of String_.t | `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of Integer.t | `String of String_.t ]) list ] list | `String of String_.t | `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of Integer.t | `List of [> `Structure of (string * [> `Integer of Integer.t | `List of [> `Enum of string | `String of String_.t ] list | `String of String_.t ]) list ] list | `Map of ([> `String of String_.t ] * [> `String of String_.t ]) list | `String of String_.t | `Structure of (string * [> `Enum of string | `String of String_.t ]) list ]) list ]) list ] list | `Long of Long.t | `String of String_.t | `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of Integer.t | `List of [> `String of String_.t | `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of Integer.t | `List of [> `Structure of (string * [> `Boolean of Boolean.t | `Integer of Integer.t | `List of [> `String of String_.t | `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of Integer.t | `String of String_.t ]) list ] list | `String of String_.t | `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of Integer.t | `List of [> `Structure of (string * [> `Integer of Integer.t | `List of [> `Enum of string | `String of String_.t ] list | `String of String_.t ]) list ] list | `Map of ([> `String of String_.t ] * [> `String of String_.t ]) list | `String of String_.t | `Structure of (string * [> `Enum of string | `String of String_.t ]) list ]) list ]) list ] list | `Long of Long.t | `String of String_.t | `Structure of (string * [> `Enum of string | `Integer of Integer.t | `String of String_.t | `Structure of (string * [> `Enum of string | `String of String_.t ]) list ]) list ]) list ] list | `String of String_.t | `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of Integer.t | `List of [> `Structure of (string * [> `Integer of Integer.t | `List of [> `Enum of string | `String of String_.t | `Structure of (string * [> `Boolean of Boolean.t | `String of String_.t ]) list ] list | `String of String_.t | `Structure of (string * [> `Boolean of Boolean.t | `Long of Long.t | `Map of ([> `String of String_.t ] * [> `String of Quantity.t ]) list | `String of String_.t ]) list ]) list ] list | `Map of ([> `String of String_.t ] * [> `String of String_.t ]) list | `String of String_.t | `Structure of (string * [> `Map of ([> `String of String_.t ] * [> `String of String_.t ]) list | `String of String_.t ]) list ]) list ]) list ]) list ] list | `Long of Long.t | `Map of ([> `String of String_.t ] * [> `Integer of Integer.t ]) list | `String of String_.t | `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of Integer.t | `List of [> `Structure of (string * [> `Integer of Integer.t | `List of [> `Enum of string | `String of String_.t | `Structure of (string * [> `Boolean of Boolean.t | `String of String_.t ]) list ] list | `String of String_.t | `Structure of (string * [> `Boolean of Boolean.t | `Long of Long.t | `Map of ([> `String of String_.t ] * [> `String of Quantity.t ]) list | `String of String_.t ]) list ]) list ] list | `Map of ([> `String of String_.t ] * [> `String of String_.t ]) list | `String of String_.t | `Structure of (string * [> `Map of ([> `String of String_.t ] * [> `String of String_.t ]) list | `String of String_.t ]) list ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t