Struct aws_sdk_iot::operation::create_job_template::CreateJobTemplateInput

#[non_exhaustive]
pub struct CreateJobTemplateInput {

    pub job_template_id: Option<String>,
    pub job_arn: Option<String>,
    pub document_source: Option<String>,
    pub document: Option<String>,
    pub description: Option<String>,
    pub presigned_url_config: Option<PresignedUrlConfig>,
    pub job_executions_rollout_config: Option<JobExecutionsRolloutConfig>,
    pub abort_config: Option<AbortConfig>,
    pub timeout_config: Option<TimeoutConfig>,
    pub tags: Option<Vec<Tag>>,
    pub job_executions_retry_config: Option<JobExecutionsRetryConfig>,
    pub maintenance_windows: Option<Vec<MaintenanceWindow>>,
    pub destination_package_versions: Option<Vec<String>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

job_template_id: Option<String>

A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

job_arn: Option<String>

The ARN of the job to use as the basis for the job template.

document_source: Option<String>

An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.

For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

For more information, see Methods for accessing a bucket.

document: Option<String>

The job document. Required if you don't specify a value for documentSource.

description: Option<String>

A description of the job document.

presigned_url_config: Option<PresignedUrlConfig>

Configuration for pre-signed S3 URLs.

job_executions_rollout_config: Option<JobExecutionsRolloutConfig>

Allows you to create a staged rollout of a job.

abort_config: Option<AbortConfig>

The criteria that determine when and how a job abort takes place.

timeout_config: Option<TimeoutConfig>

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 IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

tags: Option<Vec<Tag>>

Metadata that can be used to manage the job template.

job_executions_retry_config: Option<JobExecutionsRetryConfig>

Allows you to create the criteria to retry a job.

maintenance_windows: Option<Vec<MaintenanceWindow>>

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.

destination_package_versions: Option<Vec<String>>

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.

Implementations

impl CreateJobTemplateInput

pub fn job_template_id(&self) -> Option<&str>

A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

pub fn job_arn(&self) -> Option<&str>

The ARN of the job to use as the basis for the job template.

pub fn document_source(&self) -> Option<&str>

An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.

For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

For more information, see Methods for accessing a bucket.

pub fn document(&self) -> Option<&str>

The job document. Required if you don't specify a value for documentSource.

pub fn description(&self) -> Option<&str>

A description of the job document.

pub fn presigned_url_config(&self) -> Option<&PresignedUrlConfig>

Configuration for pre-signed S3 URLs.

pub fn job_executions_rollout_config( &self ) -> Option<&JobExecutionsRolloutConfig>

Allows you to create a staged rollout of a job.

pub fn abort_config(&self) -> Option<&AbortConfig>

The criteria that determine when and how a job abort takes place.

pub fn timeout_config(&self) -> Option<&TimeoutConfig>

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 IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

pub fn tags(&self) -> &[Tag]

Metadata that can be used to manage the job template.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn job_executions_retry_config(&self) -> Option<&JobExecutionsRetryConfig>

Allows you to create the criteria to retry a job.

pub fn maintenance_windows(&self) -> &[MaintenanceWindow]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .maintenance_windows.is_none().

pub fn destination_package_versions(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .destination_package_versions.is_none().

impl CreateJobTemplateInput

pub fn builder() -> CreateJobTemplateInputBuilder

Creates a new builder-style object to manufacture CreateJobTemplateInput.

Trait Implementations

impl Clone for CreateJobTemplateInput

fn clone(&self) -> CreateJobTemplateInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateJobTemplateInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateJobTemplateInput

fn eq(&self, other: &CreateJobTemplateInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateJobTemplateInput