Struct aws_sdk_iot::client::fluent_builders::CreateJobTemplate
source · [−]pub struct CreateJobTemplate { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateJobTemplate
.
Creates a job template.
Requires permission to access the CreateJobTemplate action.
Implementations
sourceimpl CreateJobTemplate
impl CreateJobTemplate
sourcepub async fn send(
self
) -> Result<CreateJobTemplateOutput, SdkError<CreateJobTemplateError>>
pub async fn send(
self
) -> Result<CreateJobTemplateOutput, SdkError<CreateJobTemplateError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn job_template_id(self, input: impl Into<String>) -> Self
pub fn job_template_id(self, input: impl Into<String>) -> Self
A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.
sourcepub fn set_job_template_id(self, input: Option<String>) -> Self
pub fn set_job_template_id(self, input: Option<String>) -> Self
A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.
sourcepub fn job_arn(self, input: impl Into<String>) -> Self
pub fn job_arn(self, input: impl Into<String>) -> Self
The ARN of the job to use as the basis for the job template.
sourcepub fn set_job_arn(self, input: Option<String>) -> Self
pub fn set_job_arn(self, input: Option<String>) -> Self
The ARN of the job to use as the basis for the job template.
sourcepub fn document_source(self, input: impl Into<String>) -> Self
pub fn document_source(self, input: impl Into<String>) -> Self
An S3 link to the job document to use in the template. 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 set_document_source(self, input: Option<String>) -> Self
pub fn set_document_source(self, input: Option<String>) -> Self
An S3 link to the job document to use in the template. 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, input: impl Into<String>) -> Self
pub fn document(self, input: impl Into<String>) -> Self
The job document. Required if you don't specify a value for documentSource
.
sourcepub fn set_document(self, input: Option<String>) -> Self
pub fn set_document(self, input: Option<String>) -> Self
The job document. Required if you don't specify a value for documentSource
.
sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the job document.
sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the job document.
sourcepub fn presigned_url_config(self, input: PresignedUrlConfig) -> Self
pub fn presigned_url_config(self, input: PresignedUrlConfig) -> Self
Configuration for pre-signed S3 URLs.
sourcepub fn set_presigned_url_config(self, input: Option<PresignedUrlConfig>) -> Self
pub fn set_presigned_url_config(self, input: Option<PresignedUrlConfig>) -> Self
Configuration for pre-signed S3 URLs.
sourcepub fn job_executions_rollout_config(
self,
input: JobExecutionsRolloutConfig
) -> Self
pub fn job_executions_rollout_config(
self,
input: JobExecutionsRolloutConfig
) -> Self
Allows you to create a staged rollout of a job.
sourcepub fn set_job_executions_rollout_config(
self,
input: Option<JobExecutionsRolloutConfig>
) -> Self
pub fn set_job_executions_rollout_config(
self,
input: Option<JobExecutionsRolloutConfig>
) -> Self
Allows you to create a staged rollout of a job.
sourcepub fn abort_config(self, input: AbortConfig) -> Self
pub fn abort_config(self, input: AbortConfig) -> Self
The criteria that determine when and how a job abort takes place.
sourcepub fn set_abort_config(self, input: Option<AbortConfig>) -> Self
pub fn set_abort_config(self, input: Option<AbortConfig>) -> Self
The criteria that determine when and how a job abort takes place.
sourcepub fn timeout_config(self, input: TimeoutConfig) -> Self
pub fn timeout_config(self, input: TimeoutConfig) -> Self
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
.
sourcepub fn set_timeout_config(self, input: Option<TimeoutConfig>) -> Self
pub fn set_timeout_config(self, input: Option<TimeoutConfig>) -> Self
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
.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
Metadata that can be used to manage the job template.
Metadata that can be used to manage the job template.
sourcepub fn job_executions_retry_config(
self,
input: JobExecutionsRetryConfig
) -> Self
pub fn job_executions_retry_config(
self,
input: JobExecutionsRetryConfig
) -> Self
Allows you to create the criteria to retry a job.
sourcepub fn set_job_executions_retry_config(
self,
input: Option<JobExecutionsRetryConfig>
) -> Self
pub fn set_job_executions_retry_config(
self,
input: Option<JobExecutionsRetryConfig>
) -> Self
Allows you to create the criteria to retry a job.
Trait Implementations
sourceimpl Clone for CreateJobTemplate
impl Clone for CreateJobTemplate
sourcefn clone(&self) -> CreateJobTemplate
fn clone(&self) -> CreateJobTemplate
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
Auto Trait Implementations
impl !RefUnwindSafe for CreateJobTemplate
impl Send for CreateJobTemplate
impl Sync for CreateJobTemplate
impl Unpin for CreateJobTemplate
impl !UnwindSafe for CreateJobTemplate
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub 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.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub 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