Skip to content

DescribeJobTemplateResponse

Source code in docs_src/capo_iot/types/describe_job_template_response.py
class DescribeJobTemplateResponse(TypedDict, closed=True):
    job_template_arn: NotRequired["capo_iot.types.job_template_arn.JobTemplateArn"]
    """<p>The ARN of the job template.</p>"""
    job_template_id: NotRequired["capo_iot.types.job_template_id.JobTemplateId"]
    """<p>The unique identifier of the job template.</p>"""
    description: NotRequired["capo_iot.types.job_description.JobDescription"]
    """<p>A description of the job template.</p>"""
    document_source: NotRequired["capo_iot.types.job_document_source.JobDocumentSource"]
    """<p>An S3 link to the job document.</p>"""
    document: NotRequired["capo_iot.types.job_document.JobDocument"]
    """<p>The job document.</p>"""
    created_at: NotRequired["capo_iot.types.date_type.DateType"]
    """<p>The time, in seconds since the epoch, when the job template was created.</p>"""
    presigned_url_config: NotRequired[
        "capo_iot.types.presigned_url_config.PresignedUrlConfig"
    ]
    job_executions_rollout_config: NotRequired[
        "capo_iot.types.job_executions_rollout_config.JobExecutionsRolloutConfig"
    ]
    abort_config: NotRequired["capo_iot.types.abort_config.AbortConfig"]
    timeout_config: NotRequired["capo_iot.types.timeout_config.TimeoutConfig"]
    job_executions_retry_config: NotRequired[
        "capo_iot.types.job_executions_retry_config.JobExecutionsRetryConfig"
    ]
    """<p>The configuration that determines how many retries are allowed for each failure type for a job.</p>"""
    maintenance_windows: NotRequired[
        "capo_iot.types.maintenance_windows.MaintenanceWindows"
    ]
    """<p>Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.</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>.</p> <p> <b>Note:</b>The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.</p>"""

abort_config instance-attribute

abort_config: NotRequired[AbortConfig]

created_at instance-attribute

created_at: NotRequired[DateType]

The time, in seconds since the epoch, when the job template was created.

description instance-attribute

description: NotRequired[JobDescription]

A description of the job template.

destination_package_versions instance-attribute

destination_package_versions: NotRequired[DestinationPackageVersions]

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 Package version lifecycle.

Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

document instance-attribute

document: NotRequired[JobDocument]

The job document.

document_source instance-attribute

document_source: NotRequired[JobDocumentSource]

An S3 link to the job document.

job_executions_retry_config instance-attribute

job_executions_retry_config: NotRequired[JobExecutionsRetryConfig]

The configuration that determines how many retries are allowed for each failure type for a job.

job_executions_rollout_config instance-attribute

job_executions_rollout_config: NotRequired[JobExecutionsRolloutConfig]

job_template_arn instance-attribute

job_template_arn: NotRequired[JobTemplateArn]

The ARN of the job template.

job_template_id instance-attribute

job_template_id: NotRequired[JobTemplateId]

The unique identifier of the job template.

maintenance_windows instance-attribute

maintenance_windows: NotRequired[MaintenanceWindows]

Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

presigned_url_config instance-attribute

presigned_url_config: NotRequired[PresignedUrlConfig]

timeout_config instance-attribute

timeout_config: NotRequired[TimeoutConfig]