Struct aws_sdk_iot::operation::list_jobs::builders::ListJobsFluentBuilder
source · pub struct ListJobsFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to ListJobs
.
Lists jobs.
Requires permission to access the ListJobs action.
Implementations§
source§impl ListJobsFluentBuilder
impl ListJobsFluentBuilder
sourcepub fn as_input(&self) -> &ListJobsInputBuilder
pub fn as_input(&self) -> &ListJobsInputBuilder
Access the ListJobs as a reference.
sourcepub async fn send(
self
) -> Result<ListJobsOutput, SdkError<ListJobsError, HttpResponse>>
pub async fn send( self ) -> Result<ListJobsOutput, SdkError<ListJobsError, HttpResponse>>
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 customize(
self
) -> CustomizableOperation<ListJobsOutput, ListJobsError, Self>
pub fn customize( self ) -> CustomizableOperation<ListJobsOutput, ListJobsError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn into_paginator(self) -> ListJobsPaginator
pub fn into_paginator(self) -> ListJobsPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
sourcepub fn status(self, input: JobStatus) -> Self
pub fn status(self, input: JobStatus) -> Self
An optional filter that lets you search for jobs that have the specified status.
sourcepub fn set_status(self, input: Option<JobStatus>) -> Self
pub fn set_status(self, input: Option<JobStatus>) -> Self
An optional filter that lets you search for jobs that have the specified status.
sourcepub fn get_status(&self) -> &Option<JobStatus>
pub fn get_status(&self) -> &Option<JobStatus>
An optional filter that lets you search for jobs that have the specified status.
sourcepub fn target_selection(self, input: TargetSelection) -> Self
pub fn target_selection(self, input: TargetSelection) -> Self
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.
We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
sourcepub fn set_target_selection(self, input: Option<TargetSelection>) -> Self
pub fn set_target_selection(self, input: Option<TargetSelection>) -> Self
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.
We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
sourcepub fn get_target_selection(&self) -> &Option<TargetSelection>
pub fn get_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.
We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The maximum number of results to return per request.
sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
The maximum number of results to return per request.
sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
The maximum number of results to return per request.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
The token to retrieve the next set of results.
sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
The token to retrieve the next set of results.
sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
The token to retrieve the next set of results.
sourcepub fn thing_group_name(self, input: impl Into<String>) -> Self
pub fn thing_group_name(self, input: impl Into<String>) -> Self
A filter that limits the returned jobs to those for the specified group.
sourcepub fn set_thing_group_name(self, input: Option<String>) -> Self
pub fn set_thing_group_name(self, input: Option<String>) -> Self
A filter that limits the returned jobs to those for the specified group.
sourcepub fn get_thing_group_name(&self) -> &Option<String>
pub fn get_thing_group_name(&self) -> &Option<String>
A filter that limits the returned jobs to those for the specified group.
sourcepub fn thing_group_id(self, input: impl Into<String>) -> Self
pub fn thing_group_id(self, input: impl Into<String>) -> Self
A filter that limits the returned jobs to those for the specified group.
sourcepub fn set_thing_group_id(self, input: Option<String>) -> Self
pub fn set_thing_group_id(self, input: Option<String>) -> Self
A filter that limits the returned jobs to those for the specified group.
sourcepub fn get_thing_group_id(&self) -> &Option<String>
pub fn get_thing_group_id(&self) -> &Option<String>
A filter that limits the returned jobs to those for the specified group.
sourcepub fn namespace_id(self, input: impl Into<String>) -> Self
pub fn namespace_id(self, input: impl Into<String>) -> Self
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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
sourcepub fn set_namespace_id(self, input: Option<String>) -> Self
pub fn set_namespace_id(self, input: Option<String>) -> Self
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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
sourcepub fn get_namespace_id(&self) -> &Option<String>
pub fn get_namespace_id(&self) -> &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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
Trait Implementations§
source§impl Clone for ListJobsFluentBuilder
impl Clone for ListJobsFluentBuilder
source§fn clone(&self) -> ListJobsFluentBuilder
fn clone(&self) -> ListJobsFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more