Struct aws_sdk_iot::operation::list_jobs::ListJobsInput

#[non_exhaustive]
pub struct ListJobsInput {
    pub status: Option<JobStatus>,
    pub target_selection: Option<TargetSelection>,
    pub max_results: Option<i32>,
    pub next_token: Option<String>,
    pub thing_group_name: Option<String>,
    pub thing_group_id: Option<String>,
    pub namespace_id: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

status: Option<JobStatus>

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

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.

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.

max_results: Option<i32>

The maximum number of results to return per request.

next_token: Option<String>

The token to retrieve the next set of results.

thing_group_name: Option<String>

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

thing_group_id: Option<String>

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

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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

Implementations

impl ListJobsInput

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

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

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.

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.

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

The maximum number of results to return per request.

pub fn next_token(&self) -> Option<&str>

The token to retrieve the next set of results.

pub fn thing_group_name(&self) -> Option<&str>

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

pub fn thing_group_id(&self) -> Option<&str>

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

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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

impl ListJobsInput

pub fn builder() -> ListJobsInputBuilder

Creates a new builder-style object to manufacture ListJobsInput.

Trait Implementations

impl Clone for ListJobsInput

fn clone(&self) -> ListJobsInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListJobsInput

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

Formats the value using the given formatter.

impl PartialEq for ListJobsInput

fn eq(&self, other: &ListJobsInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ListJobsInput