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

source

pub fn as_input(&self) -> &ListJobsInputBuilder

Access the ListJobs as a reference.

source

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.

source

pub fn customize( self ) -> CustomizableOperation<ListJobsOutput, ListJobsError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

source

pub fn into_paginator(self) -> ListJobsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a PaginationStream.

source

pub fn status(self, input: JobStatus) -> Self

An optional filter that lets you search for jobs that have the specified status.

source

pub fn set_status(self, input: Option<JobStatus>) -> Self

An optional filter that lets you search for jobs that have the specified status.

source

pub fn get_status(&self) -> &Option<JobStatus>

An optional filter that lets you search for jobs that have the specified status.

source

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.

source

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.

source

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.

source

pub fn max_results(self, input: i32) -> Self

The maximum number of results to return per request.

source

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of results to return per request.

source

pub fn get_max_results(&self) -> &Option<i32>

The maximum number of results to return per request.

source

pub fn next_token(self, input: impl Into<String>) -> Self

The token to retrieve the next set of results.

source

pub fn set_next_token(self, input: Option<String>) -> Self

The token to retrieve the next set of results.

source

pub fn get_next_token(&self) -> &Option<String>

The token to retrieve the next set of results.

source

pub fn thing_group_name(self, input: impl Into<String>) -> Self

A filter that limits the returned jobs to those for the specified group.

source

pub fn set_thing_group_name(self, input: Option<String>) -> Self

A filter that limits the returned jobs to those for the specified group.

source

pub fn get_thing_group_name(&self) -> &Option<String>

A filter that limits the returned jobs to those for the specified group.

source

pub fn thing_group_id(self, input: impl Into<String>) -> Self

A filter that limits the returned jobs to those for the specified group.

source

pub fn set_thing_group_id(self, input: Option<String>) -> Self

A filter that limits the returned jobs to those for the specified group.

source

pub fn get_thing_group_id(&self) -> &Option<String>

A filter that limits the returned jobs to those for the specified group.

source

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.

source

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.

source

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

source§

fn clone(&self) -> ListJobsFluentBuilder

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ListJobsFluentBuilder

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more