Struct aws_sdk_iot::input::CreateJobInput [−][src]
#[non_exhaustive]pub struct CreateJobInput {Show 13 fields
pub job_id: Option<String>,
pub targets: Option<Vec<String>>,
pub document_source: Option<String>,
pub document: Option<String>,
pub description: Option<String>,
pub presigned_url_config: Option<PresignedUrlConfig>,
pub target_selection: Option<TargetSelection>,
pub job_executions_rollout_config: Option<JobExecutionsRolloutConfig>,
pub abort_config: Option<AbortConfig>,
pub timeout_config: Option<TimeoutConfig>,
pub tags: Option<Vec<Tag>>,
pub namespace_id: Option<String>,
pub job_template_arn: Option<String>,
}
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.job_id: Option<String>
A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.
targets: Option<Vec<String>>
A list of things and thing groups to which the job should be sent.
document_source: Option<String>
An S3 link to the job document. Required if you don't specify a value for document
.
If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
The placeholder link is of the following form:
${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
where bucket is your bucket name and key is the object in the bucket to which you are linking.
document: Option<String>
The job document. Required if you don't specify a value for documentSource
.
description: Option<String>
A short text description of the job.
presigned_url_config: Option<PresignedUrlConfig>
Configuration information for pre-signed S3 URLs.
target_selection: Option<TargetSelection>
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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
job_executions_rollout_config: Option<JobExecutionsRolloutConfig>
Allows you to create a staged rollout of the job.
abort_config: Option<AbortConfig>
Allows you to create criteria to abort a job.
timeout_config: Option<TimeoutConfig>
Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be
automatically set to TIMED_OUT
.
Metadata which can be used to manage the job.
namespace_id: Option<String>
The namespace used to indicate that a job is a customer-managed job.
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.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId
feature is in public preview.
job_template_arn: Option<String>
The ARN of the job template used to create the job.
Implementations
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateJob, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateJob, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<CreateJob
>
Creates a new builder-style object to manufacture CreateJobInput
A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.
A list of things and thing groups to which the job should be sent.
An S3 link to the job document. Required if you don't specify a value for document
.
If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
The placeholder link is of the following form:
${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
where bucket is your bucket name and key is the object in the bucket to which you are linking.
The job document. Required if you don't specify a value for documentSource
.
A short text description of the job.
Configuration information for pre-signed S3 URLs.
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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
Allows you to create a staged rollout of the job.
Allows you to create criteria to abort a job.
Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be
automatically set to TIMED_OUT
.
Metadata which can be used to manage the job.
The namespace used to indicate that a job is a customer-managed job.
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.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId
feature is in public preview.
The ARN of the job template used to create the job.
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for CreateJobInput
impl Send for CreateJobInput
impl Sync for CreateJobInput
impl Unpin for CreateJobInput
impl UnwindSafe for CreateJobInput
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more