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, 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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

The maximum number of results to return per request.

Returns:

  • (Integer)


12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 12018

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

#namespace_idString

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.

Returns:

  • (String)


12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 12018

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

#next_tokenString

The token to retrieve the next set of results.

Returns:

  • (String)


12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 12018

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

#statusString

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

Returns:

  • (String)


12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 12018

class ListJobsRequest < Struct.new(
  :status,
  :target_selection,
  :max_results,
  :next_token,
  :thing_group_name,
  :thing_group_id,
  :namespace_id)
  SENSITIVE = []
  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)


12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 12018

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

#thing_group_idString

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

Returns:

  • (String)


12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 12018

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

#thing_group_nameString

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

Returns:

  • (String)


12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 12018

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