Class: Aws::IoT::Types::ListJobExecutionsForThingRequest

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 ListJobExecutionsForThingRequest data as a hash:

{
  thing_name: "ThingName", # required
  status: "QUEUED", # accepts QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, TIMED_OUT, REJECTED, REMOVED, CANCELED
  namespace_id: "NamespaceId",
  max_results: 1,
  next_token: "NextToken",
  job_id: "JobId",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#job_idString

The unique identifier you assigned to this job when it was created.

Returns:

  • (String)


11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 11893

class ListJobExecutionsForThingRequest < Struct.new(
  :thing_name,
  :status,
  :namespace_id,
  :max_results,
  :next_token,
  :job_id)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to be returned per request.

Returns:

  • (Integer)


11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 11893

class ListJobExecutionsForThingRequest < Struct.new(
  :thing_name,
  :status,
  :namespace_id,
  :max_results,
  :next_token,
  :job_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)


11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 11893

class ListJobExecutionsForThingRequest < Struct.new(
  :thing_name,
  :status,
  :namespace_id,
  :max_results,
  :next_token,
  :job_id)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token to retrieve the next set of results.

Returns:

  • (String)


11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 11893

class ListJobExecutionsForThingRequest < Struct.new(
  :thing_name,
  :status,
  :namespace_id,
  :max_results,
  :next_token,
  :job_id)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 11893

class ListJobExecutionsForThingRequest < Struct.new(
  :thing_name,
  :status,
  :namespace_id,
  :max_results,
  :next_token,
  :job_id)
  SENSITIVE = []
  include Aws::Structure
end

#thing_nameString

The thing name.

Returns:

  • (String)


11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 11893

class ListJobExecutionsForThingRequest < Struct.new(
  :thing_name,
  :status,
  :namespace_id,
  :max_results,
  :next_token,
  :job_id)
  SENSITIVE = []
  include Aws::Structure
end