Enumerated types

Enumerated types of the provisioning library. More...

Enumerations
enum	AwsIotProvisioningError_t {   AWS_IOT_PROVISIONING_SUCCESS = 1, AWS_IOT_PROVISIONING_INIT_FAILED = 2, AWS_IOT_PROVISIONING_NOT_INITIALIZED = 3, AWS_IOT_PROVISIONING_BAD_PARAMETER = 4,   AWS_IOT_PROVISIONING_NO_MEMORY = 5, AWS_IOT_PROVISIONING_BAD_RESPONSE = 6, AWS_IOT_PROVISIONING_TIMEOUT = 7, AWS_IOT_PROVISIONING_SERVER_REFUSED = 8,   AWS_IOT_PROVISIONING_INTERNAL_FAILURE = 9, AWS_IOT_PROVISIONING_MQTT_ERROR = 10 }
	Return codes of Provisioning functions. More...
enum	AwsIotProvisioningServerStatusCode_t {   AWS_IOT_PROVISIONING_SERVER_STATUS_ACCEPTED = 202, AWS_IOT_PROVISIONING_SERVER_STATUS_INVALID_CSR = 400, AWS_IOT_PROVISIONING_SERVER_STATUS_FORBIDDEN = 403, AWS_IOT_PROVISIONING_SERVER_STATUS_NOT_FOUND = 404,   AWS_IOT_PROVISIONING_SERVER_STATUS_TOO_MANY_REQUESTS = 429, AWS_IOT_PROVISIONING_SERVER_STATUS_INTERNAL_SERVER_ERROR = 500 }
	Status code sent by the server in its response during an Provisioning operations. More...

Detailed Description

Enumerated types of the provisioning library.

Enumeration Type Documentation

AwsIotProvisioningError_t

enum AwsIotProvisioningError_t

Return codes of Provisioning functions.

The function AwsIotProvisioning_strerror can be used to get a return code's description.

Enumerator
AWS_IOT_PROVISIONING_SUCCESS	Provisioning operation completed successfully. Functions that may return this value:
AWS_IOT_PROVISIONING_INIT_FAILED	Library initialization failure. Functions that may return this value: AwsIotProvisioning_Init
AWS_IOT_PROVISIONING_NOT_INITIALIZED	An API function was called before AwsIotProvisioning_Init. Functions that may return this value: AwsIotProvisioning_CreateKeysAndCertificate AwsIotProvisioning_CreateCertificateFromCsr AwsIotProvisioning_RegisterThing
AWS_IOT_PROVISIONING_BAD_PARAMETER	At least one parameter is invalid. Functions that may return this value: AwsIotProvisioning_CreateKeysAndCertificate AwsIotProvisioning_CreateCertificateFromCsr AwsIotProvisioning_RegisterThing
AWS_IOT_PROVISIONING_NO_MEMORY	Provisioning operation failed because of memory allocation failure. Functions that may return this value: AwsIotProvisioning_CreateKeysAndCertificate AwsIotProvisioning_CreateCertificateFromCsr AwsIotProvisioning_RegisterThing
AWS_IOT_PROVISIONING_BAD_RESPONSE	Provisioning response received from the network is malformed, corrupt or incomplete. Functions that may return this value: AwsIotProvisioning_CreateKeysAndCertificate AwsIotProvisioning_CreateCertificateFromCsr AwsIotProvisioning_RegisterThing
AWS_IOT_PROVISIONING_TIMEOUT	An Provisioning operation timed out. Functions that may return this value: AwsIotProvisioning_CreateKeysAndCertificate AwsIotProvisioning_CreateCertificateFromCsr AwsIotProvisioning_RegisterThing
AWS_IOT_PROVISIONING_SERVER_REFUSED	An Provisioning operation request is rejected by the server. Functions that may return this value: AwsIotProvisioning_CreateKeysAndCertificate AwsIotProvisioning_CreateCertificateFromCsr AwsIotProvisioning_RegisterThing
AWS_IOT_PROVISIONING_INTERNAL_FAILURE	Provisioning operation failed due to internal error. Functions that may return this value: AwsIotProvisioning_CreateKeysAndCertificate AwsIotProvisioning_CreateCertificateFromCsr AwsIotProvisioning_RegisterThing
AWS_IOT_PROVISIONING_MQTT_ERROR	Generic code for any MQTT operation error encountered during an Provisioning operation. Functions that may return this value: AwsIotProvisioning_CreateKeysAndCertificate AwsIotProvisioning_CreateCertificateFromCsr AwsIotProvisioning_RegisterThing

AwsIotProvisioningServerStatusCode_t

enum AwsIotProvisioningServerStatusCode_t

Status code sent by the server in its response during an Provisioning operations.

These status codes will be sent as parameters to AwsIotProvisioningCreateKeysAndCertificateCallbackInfo_t and AwsIotProvisioningRegisterThingCallbackInfo_t callback functions on receiving a response from the server.

Enumerator
AWS_IOT_PROVISIONING_SERVER_STATUS_ACCEPTED	Provisioning operation: Request Accepted by Server.
AWS_IOT_PROVISIONING_SERVER_STATUS_INVALID_CSR	Provisioning operation rejected: Invalid Certificate-Signing Request.
AWS_IOT_PROVISIONING_SERVER_STATUS_FORBIDDEN	Provisioning operation rejected: Forbidden.
AWS_IOT_PROVISIONING_SERVER_STATUS_NOT_FOUND	Provisioning operation rejected: Template ID not found.
AWS_IOT_PROVISIONING_SERVER_STATUS_TOO_MANY_REQUESTS	Provisioning operation rejected: Server has too many requests from clients.
AWS_IOT_PROVISIONING_SERVER_STATUS_INTERNAL_SERVER_ERROR	Provisioning operation rejected due to server internal error.