Class IotIdentityClientv2

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

Hierarchy

IotIdentityClientv2

Index

Methods - IotIdentity

createCertificateFromCsr createKeysAndCertificate registerThing

Methods - Other

close newFromMqtt311 newFromMqtt5

Methods - IotIdentity

createCertificateFromCsr

createCertificateFromCsr(request): Promise<CreateCertificateFromCsrResponse>
Creates 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.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api
Parameters
- request: CreateCertificateFromCsrRequest
  
  operation to perform
Returns Promise<CreateCertificateFromCsrResponse>
Promise which resolves into the response to the request

createKeysAndCertificate

createKeysAndCertificate(request): Promise<CreateKeysAndCertificateResponse>
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.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api
Parameters
- request: CreateKeysAndCertificateRequest
  
  operation to perform
Returns Promise<CreateKeysAndCertificateResponse>
Promise which resolves into the response to the request

registerThing

registerThing(request): Promise<RegisterThingResponse>
Provisions an AWS IoT thing using a pre-defined template.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api
Parameters
- request: RegisterThingRequest
  
  operation to perform
Returns Promise<RegisterThingResponse>
Promise which resolves into the response to the request

Methods - Other

close

close(): void
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.

Returns void

`Static` newFromMqtt311

newFromMqtt311(protocolClient, options): IotIdentityClientv2
Creates a new service client that will use an SDK MQTT 311 client as transport.
Parameters
- protocolClient: MqttClientConnection
  
  the MQTT 311 client to use for transport
- options: RequestResponseClientOptions
  
  additional service client configuration options
Returns IotIdentityClientv2
a new service client

`Static` newFromMqtt5

newFromMqtt5(protocolClient, options): IotIdentityClientv2
Creates a new service client that will use an SDK MQTT 5 client as transport.
Parameters
- protocolClient: Mqtt5Client
  
  the MQTT 5 client to use for transport
- options: RequestResponseClientOptions
  
  additional service client configuration options
Returns IotIdentityClientv2
a new service client

Generated using TypeDoc