You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::IoT::Types::ListJobsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoT::Types::ListJobsRequest
- Defined in:
- (unknown)
Overview
When passing ListJobsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
status: "IN_PROGRESS", # accepts IN_PROGRESS, CANCELED, COMPLETED, DELETION_IN_PROGRESS
target_selection: "CONTINUOUS", # accepts CONTINUOUS, SNAPSHOT
max_results: 1,
next_token: "NextToken",
thing_group_name: "ThingGroupName",
thing_group_id: "ThingGroupId",
namespace_id: "NamespaceId",
}
Instance Attribute Summary collapse
-
#max_results ⇒ Integer
The maximum number of results to return per request.
-
#namespace_id ⇒ String
The namespace used to indicate that a job is a customer-managed job.
-
#next_token ⇒ String
The token to retrieve the next set of results.
-
#status ⇒ String
An optional filter that lets you search for jobs that have the specified status.
-
#target_selection ⇒ String
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).
-
#thing_group_id ⇒ String
A filter that limits the returned jobs to those for the specified group.
-
#thing_group_name ⇒ String
A filter that limits the returned jobs to those for the specified group.
Instance Attribute Details
#max_results ⇒ Integer
The maximum number of results to return per request.
#namespace_id ⇒ String
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, AWS 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/
namespaceId
feature is in public preview.
#next_token ⇒ String
The token to retrieve the next set of results.
#status ⇒ String
An optional filter that lets you search for jobs that have the specified status.
Possible values:
- IN_PROGRESS
- CANCELED
- COMPLETED
- DELETION_IN_PROGRESS
#target_selection ⇒ String
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.
Possible values:
- CONTINUOUS
- SNAPSHOT
#thing_group_id ⇒ String
A filter that limits the returned jobs to those for the specified group.
#thing_group_name ⇒ String
A filter that limits the returned jobs to those for the specified group.