Skip to content

JobSummary

Source code in docs_src/capo_batch/types/job_summary.py
class JobSummary(TypedDict, closed=True):
    job_arn: NotRequired["capo_batch.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the job.</p>"""
    job_id: NotRequired["capo_batch.types.string.String"]
    """<p>The job ID.</p>"""
    job_name: NotRequired["capo_batch.types.string.String"]
    """<p>The job name.</p>"""
    capacity_usage: NotRequired[
        "capo_batch.types.job_capacity_usage_summary_list.JobCapacityUsageSummaryList"
    ]
    """<p>The configured capacity usage information for this job, including the unit of measure and quantity of resources.</p>"""
    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 (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>"""
    scheduled_at: NotRequired["capo_batch.types.long.Long"]
    """<p>The Unix timestamp (in milliseconds) for when the job was scheduled for execution. For more information on job statues, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/service-job-status.html">Service job status</a> in the <i>Batch User Guide</i>.</p>"""
    share_identifier: NotRequired["capo_batch.types.string.String"]
    """<p>The share identifier for the fairshare scheduling queue that this job is associated with.</p>"""
    status: NotRequired["capo_batch.types.job_status.JobStatus"]
    """<p>The current status for the 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>"""
    started_at: NotRequired["capo_batch.types.long.Long"]
    """<p>The Unix timestamp 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 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>"""
    container: NotRequired["capo_batch.types.container_summary.ContainerSummary"]
    """<p>An object that represents the details of the container that's associated with the job.</p>"""
    array_properties: NotRequired[
        "capo_batch.types.array_properties_summary.ArrayPropertiesSummary"
    ]
    """<p>The array properties of the job, if it's an array job.</p>"""
    node_properties: NotRequired[
        "capo_batch.types.node_properties_summary.NodePropertiesSummary"
    ]
    """<p>The node properties for a single node in a job summary list.</p> <note> <p>This isn't applicable to jobs that are running on Fargate resources.</p> </note>"""
    job_definition: NotRequired["capo_batch.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the job definition.</p>"""
    is_cancelled: NotRequired["capo_batch.types.boolean.Boolean"]
    """<p>Indicates whether a cancellation request has been accepted for the job. This field is only present when the value is <code>true</code>.</p>"""
    is_terminated: NotRequired["capo_batch.types.boolean.Boolean"]
    """<p>Indicates whether a termination request has been accepted for the job. This field is only present when the value is <code>true</code>.</p>"""

array_properties instance-attribute

array_properties: NotRequired[ArrayPropertiesSummary]

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

capacity_usage instance-attribute

capacity_usage: NotRequired[JobCapacityUsageSummaryList]

The configured capacity usage information for this job, including the unit of measure and quantity of resources.

container instance-attribute

container: NotRequired[ContainerSummary]

An object that represents the details of the container that's associated with the job.

created_at instance-attribute

created_at: NotRequired[Long]

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 (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.

is_cancelled instance-attribute

is_cancelled: NotRequired[Boolean]

Indicates whether a cancellation request has been accepted for the job. This field is only present when the value is true.

is_terminated instance-attribute

is_terminated: NotRequired[Boolean]

Indicates whether a termination request has been accepted for the job. This field is only present when the value is true.

job_arn instance-attribute

job_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the job.

job_definition instance-attribute

job_definition: NotRequired[String]

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

job_id instance-attribute

job_id: NotRequired[String]

The job ID.

job_name instance-attribute

job_name: NotRequired[String]

The job name.

node_properties instance-attribute

node_properties: NotRequired[NodePropertiesSummary]

The node properties for a single node in a job summary list.

This isn't applicable to jobs that are running on Fargate resources.

scheduled_at instance-attribute

scheduled_at: NotRequired[Long]

The Unix timestamp (in milliseconds) for when the job was scheduled for execution. For more information on job statues, see Service job status in the Batch User Guide.

share_identifier instance-attribute

share_identifier: NotRequired[String]

The share identifier for the fairshare scheduling queue that this job is associated with.

started_at instance-attribute

started_at: NotRequired[Long]

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

status instance-attribute

status: NotRequired[JobStatus]

The current status for the job.

status_reason instance-attribute

status_reason: NotRequired[String]

A short, human-readable string to provide more details for the current status of the job.

stopped_at instance-attribute

stopped_at: NotRequired[Long]

The Unix timestamp 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.