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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListJobExecutionsForThingRequest as input to an Aws::Client method, you can use a vanilla 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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#max_results ⇒ Integer

The maximum number of results to be returned per request.

Returns:

  • (Integer) —

    The maximum number of results to be returned 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/

The namespaceId feature is in public preview.

Returns:

  • (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.

Returns:

  • (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:

  • QUEUED
  • IN_PROGRESS
  • SUCCEEDED
  • FAILED
  • TIMED_OUT
  • REJECTED
  • REMOVED
  • CANCELED

Returns:

  • (String) —

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

#thing_name ⇒ String

The thing name.

Returns:

  • (String) —

    The thing name.