Struct aws_sdk_iot::client::fluent_builders::ListJobs

source · [−]

pub struct ListJobs { /* private fields */ }

Expand description

Fluent builder constructing a request to ListJobs.

Lists jobs.

Requires permission to access the ListJobs action.

Implementations

source

impl ListJobs

source

pub async fn send(self) -> Result<ListJobsOutput, SdkError<ListJobsError>>

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 into_paginator(self) -> ListJobsPaginator

Create a paginator for this request

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

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 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.

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.

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 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 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 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 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 in public preview.

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 in public preview.