Optional connection: MqttClientConnectionGets detailed information about a job execution.
If the device is offline, the PUBLISH packet will be sent once the connection resumes.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-describejobexecution
Message to be serialized and sent
Quality of Service for delivering this message
Promise which returns a mqtt.MqttRequest which will contain the packet id of
the PUBLISH packet.
Gets the list of all jobs for a thing that are not in a terminal state.
If the device is offline, the PUBLISH packet will be sent once the connection resumes.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-getpendingjobexecutions
Message to be serialized and sent
Quality of Service for delivering this message
Promise which returns a mqtt.MqttRequest which will contain the packet id of
the PUBLISH packet.
Gets and starts the next pending job execution for a thing (status IN_PROGRESS or QUEUED).
If the device is offline, the PUBLISH packet will be sent once the connection resumes.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-startnextpendingjobexecution
Message to be serialized and sent
Quality of Service for delivering this message
Promise which returns a mqtt.MqttRequest which will contain the packet id of
the PUBLISH packet.
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.
If the device is offline, the PUBLISH packet will be sent once the connection resumes.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-updatejobexecution
Message to be serialized and sent
Quality of Service for delivering this message
Promise which returns a mqtt.MqttRequest which will contain the packet id of
the PUBLISH packet.
Subscribes to the accepted topic for the DescribeJobExecution operation
subscribeToDescribeJobExecutionAccepted may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-describejobexecution
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotJobsErrorOptional response: DescribeJobExecutionResponsePromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribes to the rejected topic for the DescribeJobExecution operation
subscribeToDescribeJobExecutionRejected may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-describejobexecution
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotJobsErrorOptional response: RejectedErrorResponsePromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribes to the accepted topic for the GetPendingJobsExecutions operation
subscribeToGetPendingJobExecutionsAccepted may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-getpendingjobexecutions
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotJobsErrorOptional response: GetPendingJobExecutionsResponsePromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribes to the rejected topic for the GetPendingJobsExecutions operation
subscribeToGetPendingJobExecutionsRejected may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-getpendingjobexecutions
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotJobsErrorOptional response: RejectedErrorResponsePromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribes to JobExecutionsChanged notifications for a given IoT thing.
subscribeToJobExecutionsChangedEvents may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-jobexecutionschanged
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotJobsErrorOptional response: JobExecutionsChangedEventPromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
subscribeToNextJobExecutionChangedEvents may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-nextjobexecutionchanged
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotJobsErrorOptional response: NextJobExecutionChangedEventPromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribes to the accepted topic for the StartNextPendingJobExecution operation
subscribeToStartNextPendingJobExecutionAccepted may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-startnextpendingjobexecution
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotJobsErrorOptional response: StartNextJobExecutionResponsePromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribes to the rejected topic for the StartNextPendingJobExecution operation
subscribeToStartNextPendingJobExecutionRejected may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-startnextpendingjobexecution
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotJobsErrorOptional response: RejectedErrorResponsePromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribes to the accepted topic for the UpdateJobExecution operation
subscribeToUpdateJobExecutionAccepted may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-updatejobexecution
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotJobsErrorOptional response: UpdateJobExecutionResponsePromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribes to the rejected topic for the UpdateJobExecution operation
subscribeToUpdateJobExecutionRejected may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-updatejobexecution
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotJobsErrorOptional response: RejectedErrorResponsePromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Static newCreates a new IotJobsClient that uses the SDK Mqtt5 client internally.
The pre-existing constructor that is bound to the MQTT311 client makes this awkward since we must support
new IotJobsClient(mqtt311connection);
for backwards compatibility, but still want to be able to inject an MQTT5 client as well.
the MQTT5 client to use with this service client
a new IotJobsClient instance
Generated using TypeDoc
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