AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ListJobs operation. Lists jobs.

Requires permission to access the ListJobs action.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.IoT.AmazonIoTRequest
      Amazon.IoT.Model.ListJobsRequest

Namespace: Amazon.IoT.Model
Assembly: AWSSDK.IoT.dll
Version: 3.x.y.z

Syntax

C#
public class ListJobsRequest : AmazonIoTRequest
         IAmazonWebServiceRequest

The ListJobsRequest type exposes the following members

Constructors

NameDescription
Public Method ListJobsRequest()

Properties

NameTypeDescription
Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

The maximum number of results to return per request.

Public Property NamespaceId System.String

Gets and sets the property NamespaceId.

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.

Public Property NextToken System.String

Gets and sets the property NextToken.

The token to retrieve the next set of results.

Public Property Status Amazon.IoT.JobStatus

Gets and sets the property Status.

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

Public Property TargetSelection Amazon.IoT.TargetSelection

Gets and sets the property 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.

Public Property ThingGroupId System.String

Gets and sets the property ThingGroupId.

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

Public Property ThingGroupName System.String

Gets and sets the property ThingGroupName.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5