Class: AWS.IoTJobsDataPlane

Inherits:
AWS.Service show all
Identifier:
iotjobsdataplane
API Version:
2017-09-29
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

AWS IoT Jobs is a service that allows you to define a set of jobs — remote operations that are sent to and executed on one or more devices connected to AWS IoT. For example, you can define a job that instructs a set of devices to download and install application or firmware updates, reboot, rotate certificates, or perform remote troubleshooting operations.

To create a job, you make a job document which is a description of the remote operations to be performed, and you specify a list of targets that should perform the operations. The targets can be individual things, thing groups or both.

AWS IoT Jobs sends a message to inform the targets that a job is available. The target starts the execution of the job by downloading the job document, performing the operations it specifies, and reporting its progress to AWS IoT. The Jobs service provides commands to track the progress of a job on a specific target and for all the targets of the job

Sending a Request Using IoTJobsDataPlane

var iotjobsdataplane = new AWS.IoTJobsDataPlane();
iotjobsdataplane.describeJobExecution(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the IoTJobsDataPlane object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var iotjobsdataplane = new AWS.IoTJobsDataPlane({apiVersion: '2017-09-29'});

You can also set the API version globally in AWS.config.apiVersions using the iotjobsdataplane service identifier:

AWS.config.apiVersions = {
  iotjobsdataplane: '2017-09-29',
  // other service API versions
};

var iotjobsdataplane = new AWS.IoTJobsDataPlane();

Version:

  • 2017-09-29

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.IoTJobsDataPlane(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a IoTJobsDataPlane object

var iotjobsdataplane = new AWS.IoTJobsDataPlane({apiVersion: '2017-09-29'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.IoTJobsDataPlane.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.IoTJobsDataPlane.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.IoTJobsDataPlane.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

describeJobExecution(params = {}, callback) ⇒ AWS.Request

Gets details of a job execution.

Service Reference:

Examples:

Calling the describeJobExecution operation

var params = {
  jobId: 'STRING_VALUE', /* required */
  thingName: 'STRING_VALUE', /* required */
  executionNumber: 'NUMBER_VALUE',
  includeJobDocument: true || false
};
iotjobsdataplane.describeJobExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • jobId — (String)

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

    • thingName — (String)

      The thing name associated with the device the job execution is running on.

    • includeJobDocument — (Boolean)

      Optional. When set to true, the response contains the job document. The default is false.

    • executionNumber — (Integer)

      Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • execution — (map)

        Contains data about a job execution.

        • jobId — (String)

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

        • thingName — (String)

          The name of the thing that is executing the job.

        • status — (String)

          The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".

          Possible values include:
          • "QUEUED"
          • "IN_PROGRESS"
          • "SUCCEEDED"
          • "FAILED"
          • "TIMED_OUT"
          • "REJECTED"
          • "REMOVED"
          • "CANCELED"
        • statusDetails — (map<String>)

          A collection of name/value pairs that describe the status of the job execution.

        • queuedAt — (Integer)

          The time, in milliseconds since the epoch, when the job execution was enqueued.

        • startedAt — (Integer)

          The time, in milliseconds since the epoch, when the job execution was started.

        • lastUpdatedAt — (Integer)

          The time, in milliseconds since the epoch, when the job execution was last updated.

        • approximateSecondsBeforeTimedOut — (Integer)

          The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.

        • versionNumber — (Integer)

          The version of the job execution. Job execution versions are incremented each time they are updated by a device.

        • executionNumber — (Integer)

          A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.

        • jobDocument — (String)

          The content of the job document.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getPendingJobExecutions(params = {}, callback) ⇒ AWS.Request

Gets the list of all jobs for a thing that are not in a terminal status.

Service Reference:

Examples:

Calling the getPendingJobExecutions operation

var params = {
  thingName: 'STRING_VALUE' /* required */
};
iotjobsdataplane.getPendingJobExecutions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • thingName — (String)

      The name of the thing that is executing the job.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • inProgressJobs — (Array<map>)

        A list of JobExecutionSummary objects with status IN_PROGRESS.

        • jobId — (String)

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

        • queuedAt — (Integer)

          The time, in milliseconds since the epoch, when the job execution was enqueued.

        • startedAt — (Integer)

          The time, in milliseconds since the epoch, when the job execution started.

        • lastUpdatedAt — (Integer)

          The time, in milliseconds since the epoch, when the job execution was last updated.

        • versionNumber — (Integer)

          The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives an update from a device.

        • executionNumber — (Integer)

          A number that identifies a particular job execution on a particular device.

      • queuedJobs — (Array<map>)

        A list of JobExecutionSummary objects with status QUEUED.

        • jobId — (String)

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

        • queuedAt — (Integer)

          The time, in milliseconds since the epoch, when the job execution was enqueued.

        • startedAt — (Integer)

          The time, in milliseconds since the epoch, when the job execution started.

        • lastUpdatedAt — (Integer)

          The time, in milliseconds since the epoch, when the job execution was last updated.

        • versionNumber — (Integer)

          The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives an update from a device.

        • executionNumber — (Integer)

          A number that identifies a particular job execution on a particular device.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startNextPendingJobExecution(params = {}, callback) ⇒ AWS.Request

Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.

Service Reference:

Examples:

Calling the startNextPendingJobExecution operation

var params = {
  thingName: 'STRING_VALUE', /* required */
  statusDetails: {
    '<DetailsKey>': 'STRING_VALUE',
    /* '<DetailsKey>': ... */
  },
  stepTimeoutInMinutes: 'NUMBER_VALUE'
};
iotjobsdataplane.startNextPendingJobExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • thingName — (String)

      The name of the thing associated with the device.

    • statusDetails — (map<String>)

      A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

    • stepTimeoutInMinutes — (Integer)

      Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • execution — (map)

        A JobExecution object.

        • jobId — (String)

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

        • thingName — (String)

          The name of the thing that is executing the job.

        • status — (String)

          The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".

          Possible values include:
          • "QUEUED"
          • "IN_PROGRESS"
          • "SUCCEEDED"
          • "FAILED"
          • "TIMED_OUT"
          • "REJECTED"
          • "REMOVED"
          • "CANCELED"
        • statusDetails — (map<String>)

          A collection of name/value pairs that describe the status of the job execution.

        • queuedAt — (Integer)

          The time, in milliseconds since the epoch, when the job execution was enqueued.

        • startedAt — (Integer)

          The time, in milliseconds since the epoch, when the job execution was started.

        • lastUpdatedAt — (Integer)

          The time, in milliseconds since the epoch, when the job execution was last updated.

        • approximateSecondsBeforeTimedOut — (Integer)

          The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.

        • versionNumber — (Integer)

          The version of the job execution. Job execution versions are incremented each time they are updated by a device.

        • executionNumber — (Integer)

          A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.

        • jobDocument — (String)

          The content of the job document.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateJobExecution(params = {}, callback) ⇒ AWS.Request

Updates the status of a job execution.

Service Reference:

Examples:

Calling the updateJobExecution operation

var params = {
  jobId: 'STRING_VALUE', /* required */
  status: QUEUED | IN_PROGRESS | SUCCEEDED | FAILED | TIMED_OUT | REJECTED | REMOVED | CANCELED, /* required */
  thingName: 'STRING_VALUE', /* required */
  executionNumber: 'NUMBER_VALUE',
  expectedVersion: 'NUMBER_VALUE',
  includeJobDocument: true || false,
  includeJobExecutionState: true || false,
  statusDetails: {
    '<DetailsKey>': 'STRING_VALUE',
    /* '<DetailsKey>': ... */
  },
  stepTimeoutInMinutes: 'NUMBER_VALUE'
};
iotjobsdataplane.updateJobExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • jobId — (String)

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

    • thingName — (String)

      The name of the thing associated with the device.

    • status — (String)

      The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

      Possible values include:
      • "QUEUED"
      • "IN_PROGRESS"
      • "SUCCEEDED"
      • "FAILED"
      • "TIMED_OUT"
      • "REJECTED"
      • "REMOVED"
      • "CANCELED"
    • statusDetails — (map<String>)

      Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

    • stepTimeoutInMinutes — (Integer)

      Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

    • expectedVersion — (Integer)

      Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

    • includeJobExecutionState — (Boolean)

      Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

    • includeJobDocument — (Boolean)

      Optional. When set to true, the response contains the job document. The default is false.

    • executionNumber — (Integer)

      Optional. A number that identifies a particular job execution on a particular device.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • executionState — (map)

        A JobExecutionState object.

        • status — (String)

          The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".

          Possible values include:
          • "QUEUED"
          • "IN_PROGRESS"
          • "SUCCEEDED"
          • "FAILED"
          • "TIMED_OUT"
          • "REJECTED"
          • "REMOVED"
          • "CANCELED"
        • statusDetails — (map<String>)

          A collection of name/value pairs that describe the status of the job execution.

        • versionNumber — (Integer)

          The version of the job execution. Job execution versions are incremented each time they are updated by a device.

      • jobDocument — (String)

        The contents of the Job Documents.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.