Optional connection: MqttClientConnectionCreates a certificate from a certificate signing request (CSR). AWS IoT provides client certificates that are signed by the Amazon Root certificate authority (CA). The new certificate has a PENDING_ACTIVATION status. When you call RegisterThing to provision a thing with this certificate, the certificate status changes to ACTIVE or INACTIVE as described in the template.
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/provision-wo-cert.html#fleet-provision-api
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.
Creates new keys and a certificate. AWS IoT provides client certificates that are signed by the Amazon Root certificate authority (CA). The new certificate has a PENDING_ACTIVATION status. When you call RegisterThing to provision a thing with this certificate, the certificate status changes to ACTIVE or INACTIVE as described in the template.
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/provision-wo-cert.html#fleet-provision-api
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.
Provisions an AWS IoT thing using a pre-defined template.
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/provision-wo-cert.html#fleet-provision-api
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 of the CreateCertificateFromCsr operation.
subscribeToCreateCertificateFromCsrAccepted 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/provision-wo-cert.html#fleet-provision-api
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: IotIdentityErrorOptional response: CreateCertificateFromCsrResponsePromise 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 of the CreateCertificateFromCsr operation.
subscribeToCreateCertificateFromCsrRejected 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/provision-wo-cert.html#fleet-provision-api
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: IotIdentityErrorOptional response: model.ErrorResponsePromise 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 of the CreateKeysAndCertificate operation.
subscribeToCreateKeysAndCertificateAccepted 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/provision-wo-cert.html#fleet-provision-api
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: IotIdentityErrorOptional response: CreateKeysAndCertificateResponsePromise 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 of the CreateKeysAndCertificate operation.
subscribeToCreateKeysAndCertificateRejected 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/provision-wo-cert.html#fleet-provision-api
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: IotIdentityErrorOptional response: model.ErrorResponsePromise 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 of the RegisterThing operation.
subscribeToRegisterThingAccepted 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/provision-wo-cert.html#fleet-provision-api
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: IotIdentityErrorOptional response: RegisterThingResponsePromise 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 of the RegisterThing operation.
subscribeToRegisterThingRejected 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/provision-wo-cert.html#fleet-provision-api
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: IotIdentityErrorOptional response: model.ErrorResponsePromise 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 IotIdentityClient 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 IotIdentityClient(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 IotIdentityClient instance
Generated using TypeDoc
An AWS IoT service that assists with provisioning a device and installing unique client certificates on it
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html