JobDefinition ¶

class JobDefinition(TypedDict, closed=True):
    job_definition_name: NotRequired["capo_batch.types.string.String"]
    """<p>The name of the job definition.</p>"""
    job_definition_arn: NotRequired["capo_batch.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the job definition.</p>"""
    revision: NotRequired["capo_batch.types.integer.Integer"]
    """<p>The revision of the job definition.</p>"""
    status: NotRequired["capo_batch.types.string.String"]
    """<p>The status of the job definition.</p>"""
    type: NotRequired["capo_batch.types.string.String"]
    """<p>The type of job definition. It's either <code>container</code> or <code>multinode</code>. If the job is run on Fargate resources, then <code>multinode</code> isn't supported. For more information about multi-node parallel jobs, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html">Creating a multi-node parallel job definition</a> in the <i>Batch User Guide</i>.</p>"""
    scheduling_priority: NotRequired["capo_batch.types.integer.Integer"]
    """<p>The scheduling priority 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>"""
    parameters: NotRequired["capo_batch.types.parameters_map.ParametersMap"]
    """<p>Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a <code>SubmitJob</code> request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html">Job definition parameters</a> in the <i>Batch User Guide</i>.</p>"""
    retry_strategy: NotRequired["capo_batch.types.retry_strategy.RetryStrategy"]
    """<p>The retry strategy to use for failed jobs that are submitted with this job definition.</p>"""
    container_properties: NotRequired[
        "capo_batch.types.container_properties.ContainerProperties"
    ]
    """<p>An object with properties specific to Amazon ECS-based jobs. When <code>containerProperties</code> is used in the job definition, it can't be used in addition to <code>eksProperties</code>, <code>ecsProperties</code>, or <code>nodeProperties</code>.</p>"""
    timeout: NotRequired["capo_batch.types.job_timeout.JobTimeout"]
    """<p>The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.</p>"""
    node_properties: NotRequired["capo_batch.types.node_properties.NodeProperties"]
    """<p>An object with properties that are specific to multi-node parallel jobs. When <code>nodeProperties</code> is used in the job definition, it can't be used in addition to <code>containerProperties</code>, <code>ecsProperties</code>, or <code>eksProperties</code>.</p> <note> <p>If the job runs on Fargate resources, don't specify <code>nodeProperties</code>. Use <code>containerProperties</code> instead.</p> </note>"""
    tags: NotRequired["capo_batch.types.tagris_tags_map.TagrisTagsMap"]
    """<p>The tags that are applied to the job definition.</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>"""
    ecs_properties: NotRequired["capo_batch.types.ecs_properties.EcsProperties"]
    """<p>An object that contains the properties for the Amazon ECS resources of a job.When <code>ecsProperties</code> is used in the job definition, it can't be used in addition to <code>containerProperties</code>, <code>eksProperties</code>, or <code>nodeProperties</code>.</p>"""
    eks_properties: NotRequired["capo_batch.types.eks_properties.EksProperties"]
    """<p>An object with properties that are specific to Amazon EKS-based jobs. When <code>eksProperties</code> is used in the job definition, it can't be used in addition to <code>containerProperties</code>, <code>ecsProperties</code>, or <code>nodeProperties</code>.</p>"""
    container_orchestration_type: NotRequired[
        "capo_batch.types.orchestration_type.OrchestrationType"
    ]
    """<p>The orchestration type of the compute environment. The valid values are <code>ECS</code> (default) or <code>EKS</code>.</p>"""
    consumable_resource_properties: NotRequired[
        "capo_batch.types.consumable_resource_properties.ConsumableResourceProperties"
    ]
    """<p>Contains a list of consumable resources required by the job.</p>"""