JobDetail ¶

class JobDetail(TypedDict, closed=True):
    job_arn: NotRequired["capo_batch.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the job.</p>"""
    job_name: NotRequired["capo_batch.types.string.String"]
    """<p>The job name.</p>"""
    job_id: NotRequired["capo_batch.types.string.String"]
    """<p>The job ID.</p>"""
    job_queue: NotRequired["capo_batch.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the job queue that the job is associated with.</p>"""
    status: NotRequired["capo_batch.types.job_status.JobStatus"]
    """<p>The current status for the job.</p> <note> <p>If your jobs don't progress to <code>STARTING</code>, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#job_stuck_in_runnable">Jobs stuck in RUNNABLE status</a> in the troubleshooting section of the <i>Batch User Guide</i>.</p> </note>"""
    share_identifier: NotRequired["capo_batch.types.string.String"]
    """<p>The share identifier for the job.</p>"""
    scheduling_priority: NotRequired["capo_batch.types.integer.Integer"]
    """<p>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.</p>"""
    attempts: NotRequired["capo_batch.types.attempt_details.AttemptDetails"]
    """<p>A list of job attempts that are associated with this job.</p>"""
    status_reason: NotRequired["capo_batch.types.string.String"]
    """<p>A short, human-readable string to provide more details for the current status of the job.</p> <ul> <li> <p> <code>CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY</code> - All compute environments have insufficient capacity to service the job.</p> </li> <li> <p> <code>MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE</code> - All compute environments have a <code>maxVcpu</code> setting that is smaller than the job requirements.</p> </li> <li> <p> <code>MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT</code> - All compute environments have no connected instances that meet the job requirements.</p> </li> <li> <p> <code>MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS</code> - All compute environments have problems with the service role permissions.</p> </li> </ul>"""
    created_at: NotRequired["capo_batch.types.long.Long"]
    """<p>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 <code>SUBMITTED</code> state. This is specifically at the time <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html">SubmitJob</a> was called. For array child jobs, this is when the child job was spawned by its parent and entered the <code>PENDING</code> state.</p>"""
    retry_strategy: NotRequired["capo_batch.types.retry_strategy.RetryStrategy"]
    """<p>The retry strategy to use for this job if an attempt fails.</p>"""
    started_at: NotRequired["capo_batch.types.long.Long"]
    """<p>The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state. </p>"""
    stopped_at: NotRequired["capo_batch.types.long.Long"]
    """<p>The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job transitioned from the <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code>.</p>"""
    depends_on: NotRequired["capo_batch.types.job_dependency_list.JobDependencyList"]
    """<p>A list of job IDs that this job depends on.</p>"""
    job_definition: NotRequired["capo_batch.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the job definition that this job uses.</p>"""
    parameters: NotRequired["capo_batch.types.parameters_map.ParametersMap"]
    """<p>Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.</p>"""
    container: NotRequired["capo_batch.types.container_detail.ContainerDetail"]
    """<p>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. </p>"""
    node_details: NotRequired["capo_batch.types.node_details.NodeDetails"]
    """<p>An object that represents the details of a node that's associated with a multi-node parallel job.</p>"""
    node_properties: NotRequired["capo_batch.types.node_properties.NodeProperties"]
    """<p>An object that represents the node properties of a multi-node parallel job.</p> <note> <p>This isn't applicable to jobs that are running on Fargate resources.</p> </note>"""
    array_properties: NotRequired[
        "capo_batch.types.array_properties_detail.ArrayPropertiesDetail"
    ]
    """<p>The array properties of the job, if it's an array job.</p>"""
    timeout: NotRequired["capo_batch.types.job_timeout.JobTimeout"]
    """<p>The timeout configuration for the job.</p>"""
    tags: NotRequired["capo_batch.types.tagris_tags_map.TagrisTagsMap"]
    """<p>The tags that are applied to the job.</p>"""
    propagate_tags: NotRequired["capo_batch.types.boolean.Boolean"]
    """<p>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 <code>FAILED</code> state.</p>"""
    platform_capabilities: NotRequired[
        "capo_batch.types.platform_capability_list.PlatformCapabilityList"
    ]
    """<p>The platform capabilities required by the job definition. If no value is specified, it defaults to <code>EC2</code>. Jobs run on Fargate resources specify <code>FARGATE</code>. Jobs run on Amazon ECS Managed Instances specify <code>MANAGED_INSTANCES</code>.</p>"""
    eks_properties: NotRequired[
        "capo_batch.types.eks_properties_detail.EksPropertiesDetail"
    ]
    """<p>An object with various properties that are specific to Amazon EKS based jobs. </p>"""
    eks_attempts: NotRequired["capo_batch.types.eks_attempt_details.EksAttemptDetails"]
    """<p>A list of job attempts that are associated with this job.</p>"""
    ecs_properties: NotRequired[
        "capo_batch.types.ecs_properties_detail.EcsPropertiesDetail"
    ]
    """<p>An object with properties that are specific to Amazon ECS-based jobs. </p>"""
    is_cancelled: NotRequired["capo_batch.types.boolean.Boolean"]
    """<p>Indicates whether the job is cancelled.</p>"""
    is_terminated: NotRequired["capo_batch.types.boolean.Boolean"]
    """<p>Indicates whether the job is terminated.</p>"""
    consumable_resource_properties: NotRequired[
        "capo_batch.types.consumable_resource_properties.ConsumableResourceProperties"
    ]
    """<p>Contains a list of consumable resources required by the job.</p>"""