Job ¶

class Job(TypedDict, closed=True):
    job_arn: NotRequired["capo_iot.types.job_arn.JobArn"]
    """<p>An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".</p>"""
    job_id: NotRequired["capo_iot.types.job_id.JobId"]
    """<p>The unique identifier you assigned to this job when it was created.</p>"""
    target_selection: NotRequired["capo_iot.types.target_selection.TargetSelection"]
    """<p>Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group. </p> <note> <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.</p> </note>"""
    status: NotRequired["capo_iot.types.job_status.JobStatus"]
    """<p>The status of the job, one of <code>IN_PROGRESS</code>, <code>CANCELED</code>, <code>DELETION_IN_PROGRESS</code> or <code>COMPLETED</code>. </p>"""
    force_canceled: NotRequired["capo_iot.types.forced.Forced"]
    """<p>Will be <code>true</code> if the job was canceled with the optional <code>force</code> parameter set to <code>true</code>.</p>"""
    reason_code: NotRequired["capo_iot.types.reason_code.ReasonCode"]
    """<p>If the job was updated, provides the reason code for the update.</p>"""
    comment: NotRequired["capo_iot.types.comment.Comment"]
    """<p>If the job was updated, describes the reason for the update.</p>"""
    targets: NotRequired["capo_iot.types.job_targets.JobTargets"]
    """<p>A list of IoT things and thing groups to which the job should be sent.</p>"""
    description: NotRequired["capo_iot.types.job_description.JobDescription"]
    """<p>A short text description of the job.</p>"""
    presigned_url_config: NotRequired[
        "capo_iot.types.presigned_url_config.PresignedUrlConfig"
    ]
    """<p>Configuration for pre-signed S3 URLs.</p>"""
    job_executions_rollout_config: NotRequired[
        "capo_iot.types.job_executions_rollout_config.JobExecutionsRolloutConfig"
    ]
    """<p>Allows you to create a staged rollout of a job.</p>"""
    abort_config: NotRequired["capo_iot.types.abort_config.AbortConfig"]
    """<p>Configuration for criteria to abort the job.</p>"""
    created_at: NotRequired["capo_iot.types.date_type.DateType"]
    """<p>The time, in seconds since the epoch, when the job was created.</p>"""
    last_updated_at: NotRequired["capo_iot.types.date_type.DateType"]
    """<p>The time, in seconds since the epoch, when the job was last updated.</p>"""
    completed_at: NotRequired["capo_iot.types.date_type.DateType"]
    """<p>The time, in seconds since the epoch, when the job was completed.</p>"""
    job_process_details: NotRequired[
        "capo_iot.types.job_process_details.JobProcessDetails"
    ]
    """<p>Details about the job process.</p>"""
    timeout_config: NotRequired["capo_iot.types.timeout_config.TimeoutConfig"]
    """<p>Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to <code>IN_PROGRESS</code>. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to <code>TIMED_OUT</code>.</p>"""
    namespace_id: NotRequired["capo_iot.types.namespace_id.NamespaceId"]
    """<p>The namespace used to indicate that a job is a customer-managed job.</p> <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.</p> <p> <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code> </p> <note> <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting up IoT Greengrass core devices.</a> </p> </note>"""
    job_template_arn: NotRequired["capo_iot.types.job_template_arn.JobTemplateArn"]
    """<p>The ARN of the job template used to create the job.</p>"""
    job_executions_retry_config: NotRequired[
        "capo_iot.types.job_executions_retry_config.JobExecutionsRetryConfig"
    ]
    """<p>The configuration for the criteria to retry the job.</p>"""
    document_parameters: NotRequired["capo_iot.types.parameter_map.ParameterMap"]
    """<p>A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.</p> <note> <p> <code>documentParameters</code> can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.</p> </note>"""
    is_concurrent: NotRequired[
        "capo_iot.types.boolean_wrapper_object.BooleanWrapperObject"
    ]
    """<p>Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.</p>"""
    scheduling_config: NotRequired["capo_iot.types.scheduling_config.SchedulingConfig"]
    """<p>The configuration that allows you to schedule a job for a future date and time in addition to specifying the end behavior for each job execution.</p>"""
    scheduled_job_rollouts: NotRequired[
        "capo_iot.types.scheduled_job_rollout_list.ScheduledJobRolloutList"
    ]
    """<p>Displays the next seven maintenance window occurrences and their start times.</p>"""
    destination_package_versions: NotRequired[
        "capo_iot.types.destination_package_versions.DestinationPackageVersions"
    ]
    """<p>The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle">Package version lifecycle</a>.The package version must be in either the Published or Deprecated state when the job deploys. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle">Package version lifecycle</a>.</p> <p> <b>Note:</b>The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.</p>"""