Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IotJobsClient

Index

Constructors

constructor

  • new IotJobsClient(connection: MqttClientConnection): IotJobsClient
  • Parameters

    • connection: MqttClientConnection

    Returns IotJobsClient

IotJobs Methods

publishDescribeJobExecution

  • API Documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-describejobexecution Publish DescribeJobExecution message If the device is offline, the PUBLISH packet will be sent once the connection resumes.

    Parameters

    Returns Promise<MqttRequest>

    Promise which returns a mqtt.MqttRequest which will contain the packet id of the PUBLISH packet.

    • For QoS 0, completes as soon as the packet is sent.
    • For QoS 1, completes when PUBACK is received.
    • QoS 2 is not supported by AWS IoT.

publishGetPendingJobExecutions

  • API Documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-getpendingjobexecutions Publish GetPendingJobExecutions message If the device is offline, the PUBLISH packet will be sent once the connection resumes.

    Parameters

    Returns Promise<MqttRequest>

    Promise which returns a mqtt.MqttRequest which will contain the packet id of the PUBLISH packet.

    • For QoS 0, completes as soon as the packet is sent.
    • For QoS 1, completes when PUBACK is received.
    • QoS 2 is not supported by AWS IoT.

publishStartNextPendingJobExecution

publishUpdateJobExecution

  • API Documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-updatejobexecution Publish UpdateJobExecution message If the device is offline, the PUBLISH packet will be sent once the connection resumes.

    Parameters

    • request: UpdateJobExecutionRequest

      Message to be serialized and sent

    • qos: QoS

      Quality of Service for delivering this message

    Returns Promise<MqttRequest>

    Promise which returns a mqtt.MqttRequest which will contain the packet id of the PUBLISH packet.

    • For QoS 0, completes as soon as the packet is sent.
    • For QoS 1, completes when PUBACK is received.
    • QoS 2 is not supported by AWS IoT.

subscribeToDescribeJobExecutionAccepted

  • Subscribe to DescribeJobExecutionAccepted messages

    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.

    Parameters

    Returns Promise<MqttSubscribeRequest>

    Promise 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.

subscribeToDescribeJobExecutionRejected

  • Subscribe to DescribeJobExecutionRejected messages

    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.

    Parameters

    Returns Promise<MqttSubscribeRequest>

    Promise 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.

subscribeToGetPendingJobExecutionsAccepted

subscribeToGetPendingJobExecutionsRejected

  • Subscribe to GetPendingJobExecutionsRejected messages

    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.

    Parameters

    Returns Promise<MqttSubscribeRequest>

    Promise 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.

subscribeToJobExecutionsChangedEvents

  • Subscribe to JobExecutionsChangedEvents messages

    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.

    Parameters

    Returns Promise<MqttSubscribeRequest>

    Promise 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

  • Subscribe to NextJobExecutionChangedEvents messages

    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.

    Parameters

    Returns Promise<MqttSubscribeRequest>

    Promise 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.

subscribeToStartNextPendingJobExecutionAccepted

subscribeToStartNextPendingJobExecutionRejected

  • Subscribe to StartNextPendingJobExecutionRejected messages

    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.

    Parameters

    Returns Promise<MqttSubscribeRequest>

    Promise 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.

subscribeToUpdateJobExecutionAccepted

  • Subscribe to UpdateJobExecutionAccepted messages

    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.

    Parameters

    Returns Promise<MqttSubscribeRequest>

    Promise 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.

subscribeToUpdateJobExecutionRejected

  • Subscribe to UpdateJobExecutionRejected messages

    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.

    Parameters

    Returns Promise<MqttSubscribeRequest>

    Promise 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.

Generated using TypeDoc