Struct aws_sdk_iot::input::CreateJobInput
source · [−]#[non_exhaustive]pub struct CreateJobInput {Show 15 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>,
pub job_executions_retry_config: Option<JobExecutionsRetryConfig>,
pub document_parameters: Option<HashMap<String, 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 the 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.
job_executions_retry_config: Option<JobExecutionsRetryConfig>
Allows you to create the criteria to retry a job.
document_parameters: Option<HashMap<String, String>>
Parameters of a managed template that you can specify to create the job document.
Implementations
sourceimpl CreateJobInput
impl CreateJobInput
sourcepub 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
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture CreateJobInput
sourceimpl CreateJobInput
impl CreateJobInput
sourcepub fn job_id(&self) -> Option<&str>
pub fn job_id(&self) -> Option<&str>
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.
sourcepub fn targets(&self) -> Option<&[String]>
pub fn targets(&self) -> Option<&[String]>
A list of things and thing groups to which the job should be sent.
sourcepub fn document_source(&self) -> Option<&str>
pub fn document_source(&self) -> Option<&str>
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.
sourcepub fn document(&self) -> Option<&str>
pub fn document(&self) -> Option<&str>
The job document. Required if you don't specify a value for documentSource
.
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A short text description of the job.
sourcepub fn presigned_url_config(&self) -> Option<&PresignedUrlConfig>
pub fn presigned_url_config(&self) -> Option<&PresignedUrlConfig>
Configuration information for pre-signed S3 URLs.
sourcepub fn target_selection(&self) -> Option<&TargetSelection>
pub fn target_selection(&self) -> 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.
sourcepub fn job_executions_rollout_config(
&self
) -> Option<&JobExecutionsRolloutConfig>
pub fn job_executions_rollout_config(
&self
) -> Option<&JobExecutionsRolloutConfig>
Allows you to create a staged rollout of the job.
sourcepub fn abort_config(&self) -> Option<&AbortConfig>
pub fn abort_config(&self) -> Option<&AbortConfig>
Allows you to create the criteria to abort a job.
sourcepub fn timeout_config(&self) -> Option<&TimeoutConfig>
pub fn timeout_config(&self) -> 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.
sourcepub fn namespace_id(&self) -> Option<&str>
pub fn namespace_id(&self) -> Option<&str>
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.
sourcepub fn job_template_arn(&self) -> Option<&str>
pub fn job_template_arn(&self) -> Option<&str>
The ARN of the job template used to create the job.
sourcepub fn job_executions_retry_config(&self) -> Option<&JobExecutionsRetryConfig>
pub fn job_executions_retry_config(&self) -> Option<&JobExecutionsRetryConfig>
Allows you to create the criteria to retry a job.
Trait Implementations
sourceimpl Clone for CreateJobInput
impl Clone for CreateJobInput
sourcefn clone(&self) -> CreateJobInput
fn clone(&self) -> CreateJobInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CreateJobInput
impl Debug for CreateJobInput
sourceimpl PartialEq<CreateJobInput> for CreateJobInput
impl PartialEq<CreateJobInput> for CreateJobInput
sourcefn eq(&self, other: &CreateJobInput) -> bool
fn eq(&self, other: &CreateJobInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CreateJobInput) -> bool
fn ne(&self, other: &CreateJobInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for CreateJobInput
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more