You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::IoT::Types::ListJobsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass ListJobsRequest data as a hash:

{
  status: "IN_PROGRESS", # accepts IN_PROGRESS, CANCELED, COMPLETED
  target_selection: "CONTINUOUS", # accepts CONTINUOUS, SNAPSHOT
  max_results: 1,
  next_token: "NextToken",
  thing_group_name: "ThingGroupName",
  thing_group_id: "ThingGroupId",
}

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

The maximum number of results to return per request.

Returns:

  • (Integer)


4378
4379
4380
4381
4382
4383
4384
4385
4386
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4378

class ListJobsRequest < Struct.new(
  :status,
  :target_selection,
  :max_results,
  :next_token,
  :thing_group_name,
  :thing_group_id)
  include Aws::Structure
end

#next_tokenString

The token to retrieve the next set of results.

Returns:

  • (String)


4378
4379
4380
4381
4382
4383
4384
4385
4386
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4378

class ListJobsRequest < Struct.new(
  :status,
  :target_selection,
  :max_results,
  :next_token,
  :thing_group_name,
  :thing_group_id)
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


4378
4379
4380
4381
4382
4383
4384
4385
4386
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4378

class ListJobsRequest < Struct.new(
  :status,
  :target_selection,
  :max_results,
  :next_token,
  :thing_group_name,
  :thing_group_id)
  include Aws::Structure
end

#target_selectionString

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.

Returns:

  • (String)


4378
4379
4380
4381
4382
4383
4384
4385
4386
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4378

class ListJobsRequest < Struct.new(
  :status,
  :target_selection,
  :max_results,
  :next_token,
  :thing_group_name,
  :thing_group_id)
  include Aws::Structure
end

#thing_group_idString

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

Returns:

  • (String)


4378
4379
4380
4381
4382
4383
4384
4385
4386
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4378

class ListJobsRequest < Struct.new(
  :status,
  :target_selection,
  :max_results,
  :next_token,
  :thing_group_name,
  :thing_group_id)
  include Aws::Structure
end

#thing_group_nameString

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

Returns:

  • (String)


4378
4379
4380
4381
4382
4383
4384
4385
4386
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4378

class ListJobsRequest < Struct.new(
  :status,
  :target_selection,
  :max_results,
  :next_token,
  :thing_group_name,
  :thing_group_id)
  include Aws::Structure
end