aws-iot-device-sdk-v2/dist/iotjobs/iotjobsclientv2.d.ts

NodeJS API for the AWS IoT service

/**
 * @packageDocumentation
 * @module jobs
 */
import { mqtt, mqtt5 } from 'aws-crt';
import { mqtt_request_response as mqtt_rr_internal } from 'aws-crt';
import * as mqtt_request_response from '../mqtt_request_response';
import * as model from './model';
/**
 * The AWS IoT jobs service can be used to define a set of remote operations that are sent to and executed on one or more devices connected to AWS IoT.
 *
 * AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#jobs-mqtt-api
 *
 * @category IotJobs
 */
export declare class IotJobsClientv2 {
    private rrClient;
    private serviceModel;
    private constructor();
    /**
     * Creates a new service client that will use an SDK MQTT 311 client as transport.
     *
     * @param protocolClient the MQTT 311 client to use for transport
     * @param options additional service client configuration options
     *
     * @return a new service client
     *
     */
    static newFromMqtt311(protocolClient: mqtt.MqttClientConnection, options: mqtt_rr_internal.RequestResponseClientOptions): IotJobsClientv2;
    /**
     * Creates a new service client that will use an SDK MQTT 5 client as transport.
     *
     * @param protocolClient the MQTT 5 client to use for transport
     * @param options additional service client configuration options
     *
     * @return a new service client
     *
     */
    static newFromMqtt5(protocolClient: mqtt5.Mqtt5Client, options: mqtt_rr_internal.RequestResponseClientOptions): IotJobsClientv2;
    /**
     * Triggers cleanup of all resources associated with the service client.  Closing a client will fail
     * all incomplete requests and close all unclosed streaming operations.
     *
     * This must be called when finished with a client; otherwise, native resources will leak.
     */
    close(): void;
    /**
     * Gets detailed information about a job execution.
     *
     *
     * AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-describejobexecution
     *
     * @param request operation to perform
     *
     * @return Promise which resolves into the response to the request
     *
     * @category IotJobs
     */
    describeJobExecution(request: model.DescribeJobExecutionRequest): Promise<model.DescribeJobExecutionResponse>;
    /**
     * Gets the list of all jobs for a thing that are not in a terminal state.
     *
     *
     * AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-getpendingjobexecutions
     *
     * @param request operation to perform
     *
     * @return Promise which resolves into the response to the request
     *
     * @category IotJobs
     */
    getPendingJobExecutions(request: model.GetPendingJobExecutionsRequest): Promise<model.GetPendingJobExecutionsResponse>;
    /**
     * Gets and starts the next pending job execution for a thing (status IN_PROGRESS or QUEUED).
     *
     *
     * AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-startnextpendingjobexecution
     *
     * @param request operation to perform
     *
     * @return Promise which resolves into the response to the request
     *
     * @category IotJobs
     */
    startNextPendingJobExecution(request: model.StartNextPendingJobExecutionRequest): Promise<model.StartNextJobExecutionResponse>;
    /**
     * Updates the status of a job execution. You can optionally create a step timer by setting a value for the stepTimeoutInMinutes property. If you don't update the value of this property by running UpdateJobExecution again, the job execution times out when the step timer expires.
     *
     *
     * AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-updatejobexecution
     *
     * @param request operation to perform
     *
     * @return Promise which resolves into the response to the request
     *
     * @category IotJobs
     */
    updateJobExecution(request: model.UpdateJobExecutionRequest): Promise<model.UpdateJobExecutionResponse>;
    /**
     * Creates a stream of JobExecutionsChanged notifications for a given IoT thing.
     *
     *
     * AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-jobexecutionschanged
     *
     * @param config streaming operation configuration options
     *
     * @return a streaming operation which will emit an event every time a message is received on the
     *    associated MQTT topic
     *
     * @category IotJobs
     */
    createJobExecutionsChangedStream(config: model.JobExecutionsChangedSubscriptionRequest): mqtt_request_response.StreamingOperation<model.JobExecutionsChangedEvent>;
    /**
     *
     *
     *
     * AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-nextjobexecutionchanged
     *
     * @param config streaming operation configuration options
     *
     * @return a streaming operation which will emit an event every time a message is received on the
     *    associated MQTT topic
     *
     * @category IotJobs
     */
    createNextJobExecutionChangedStream(config: model.NextJobExecutionChangedSubscriptionRequest): mqtt_request_response.StreamingOperation<model.NextJobExecutionChangedEvent>;
}