Enumerated types

Enumerated types of the Jobs library. More...

Enumerations
enum	AwsIotJobsError_t {   AWS_IOT_JOBS_SUCCESS = 0, AWS_IOT_JOBS_STATUS_PENDING = 1, AWS_IOT_JOBS_INIT_FAILED = 2, AWS_IOT_JOBS_BAD_PARAMETER = 3,   AWS_IOT_JOBS_NO_MEMORY = 4, AWS_IOT_JOBS_MQTT_ERROR = 5, AWS_IOT_JOBS_BAD_RESPONSE = 7, AWS_IOT_JOBS_TIMEOUT = 8,   AWS_IOT_JOBS_NOT_INITIALIZED = 11, AWS_IOT_JOBS_INVALID_TOPIC = 12, AWS_IOT_JOBS_INVALID_JSON = 13, AWS_IOT_JOBS_INVALID_REQUEST = 14,   AWS_IOT_JOBS_INVALID_STATE = 15, AWS_IOT_JOBS_NOT_FOUND = 16, AWS_IOT_JOBS_VERSION_MISMATCH = 17, AWS_IOT_JOBS_INTERNAL_ERROR = 18,   AWS_IOT_JOBS_THROTTLED = 19, AWS_IOT_JOBS_TERMINAL_STATE = 20 }
	Return codes of Jobs functions. More...
enum	AwsIotJobState_t {   AWS_IOT_JOB_STATE_QUEUED, AWS_IOT_JOB_STATE_IN_PROGRESS, AWS_IOT_JOB_STATE_FAILED, AWS_IOT_JOB_STATE_SUCCEEDED,   AWS_IOT_JOB_STATE_CANCELED, AWS_IOT_JOB_STATE_TIMED_OUT, AWS_IOT_JOB_STATE_REJECTED, AWS_IOT_JOB_STATE_REMOVED }
	Possible states of jobs. More...
enum	AwsIotJobsCallbackType_t {   AWS_IOT_JOBS_GET_PENDING_COMPLETE = 0, AWS_IOT_JOBS_START_NEXT_COMPLETE = 1, AWS_IOT_JOBS_DESCRIBE_COMPLETE = 2, AWS_IOT_JOBS_UPDATE_COMPLETE = 3,   AWS_IOT_JOBS_NOTIFY_PENDING_CALLBACK = 4, AWS_IOT_JOBS_NOTIFY_NEXT_CALLBACK = 5 }
	Types of Jobs library callbacks. More...

Detailed Description

Enumerated types of the Jobs library.

Enumeration Type Documentation

AwsIotJobsError_t

enum AwsIotJobsError_t

Return codes of Jobs functions.

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

The values between AWS_IOT_JOBS_INVALID_TOPIC and AWS_IOT_JOBS_TERMINAL_STATE may be returned by the Jobs service upon failure of a Jobs operation. See this page for more information.

Enumerator
AWS_IOT_JOBS_SUCCESS	Jobs operation completed successfully. Functions that may return this value: AwsIotJobs_Init AwsIotJobs_Wait AwsIotJobs_GetPendingSync AwsIotJobs_StartNextSync AwsIotJobs_DescribeSync AwsIotJobs_UpdateSync AwsIotJobs_SetNotifyPendingCallback AwsIotJobs_SetNotifyNextCallback AwsIotJobs_RemovePersistentSubscriptions Will also be the value of a Jobs operation completion callback's AwsIotJobsCallbackParam_t.operation.result when successful.
AWS_IOT_JOBS_STATUS_PENDING	Jobs operation queued, awaiting result. Functions that may return this value: AwsIotJobs_GetPendingAsync AwsIotJobs_StartNextAsync AwsIotJobs_DescribeAsync AwsIotJobs_UpdateAsync
AWS_IOT_JOBS_INIT_FAILED	Initialization failed. Functions that may return this value: AwsIotJobs_Init
AWS_IOT_JOBS_BAD_PARAMETER	At least one parameter is invalid. Functions that may return this value: AwsIotJobs_GetPendingAsync and AwsIotJobs_GetPendingSync AwsIotJobs_StartNextAsync and AwsIotJobs_StartNextSync AwsIotJobs_DescribeAsync and AwsIotJobs_DescribeSync AwsIotJobs_UpdateAsync and AwsIotJobs_UpdateSync AwsIotJobs_Wait AwsIotJobs_SetNotifyPendingCallback AwsIotJobs_SetNotifyNextCallback AwsIotJobs_RemovePersistentSubscriptions
AWS_IOT_JOBS_NO_MEMORY	Jobs operation failed because of memory allocation failure. Functions that may return this value: AwsIotJobs_GetPendingAsync and AwsIotJobs_GetPendingSync AwsIotJobs_StartNextAsync and AwsIotJobs_StartNextSync AwsIotJobs_DescribeAsync and AwsIotJobs_DescribeSync AwsIotJobs_UpdateAsync and AwsIotJobs_UpdateSync AwsIotJobs_SetNotifyPendingCallback AwsIotJobs_SetNotifyNextCallback
AWS_IOT_JOBS_MQTT_ERROR	Jobs operation failed because of failure in MQTT library. Functions that may return this value: AwsIotJobs_GetPendingAsync and AwsIotJobs_GetPendingSync AwsIotJobs_StartNextAsync and AwsIotJobs_StartNextSync AwsIotJobs_DescribeAsync and AwsIotJobs_DescribeSync AwsIotJobs_UpdateAsync and AwsIotJobs_UpdateSync AwsIotJobs_SetNotifyPendingCallback AwsIotJobs_SetNotifyNextCallback AwsIotJobs_RemovePersistentSubscriptions
AWS_IOT_JOBS_BAD_RESPONSE	Response received from Jobs service not understood. Functions that may return this value: AwsIotJobs_GetPendingSync AwsIotJobs_StartNextSync AwsIotJobs_DescribeSync AwsIotJobs_UpdateSync AwsIotJobs_Wait May also be the value of a Jobs operation completion callback's AwsIotJobsCallbackParam_t.operation.result.
AWS_IOT_JOBS_TIMEOUT	A blocking Jobs operation timed out. Functions that may return this value: AwsIotJobs_GetPendingSync AwsIotJobs_StartNextSync AwsIotJobs_DescribeSync AwsIotJobs_UpdateSync AwsIotJobs_Wait AwsIotJobs_SetNotifyPendingCallback AwsIotJobs_SetNotifyNextCallback
AWS_IOT_JOBS_NOT_INITIALIZED	An API function was called before AwsIotJobs_Init. Functions that may return this value: AwsIotJobs_GetPendingAsync and AwsIotJobs_GetPendingSync AwsIotJobs_StartNextAsync and AwsIotJobs_StartNextSync AwsIotJobs_DescribeAsync and AwsIotJobs_DescribeSync AwsIotJobs_UpdateAsync and AwsIotJobs_UpdateSync AwsIotJobs_Wait AwsIotJobs_SetNotifyPendingCallback AwsIotJobs_SetNotifyNextCallback
AWS_IOT_JOBS_INVALID_TOPIC	Jobs operation failed: A request was sent to an unknown topic. Functions that may return this value: AwsIotJobs_GetPendingSync AwsIotJobs_StartNextSync AwsIotJobs_DescribeSync AwsIotJobs_UpdateSync AwsIotJobs_Wait May also be the value of a Jobs operation completion callback's AwsIotJobsCallbackParam_t.operation.result.
AWS_IOT_JOBS_INVALID_JSON	Jobs operation failed: The contents of the request were not understood. Jobs requests must be UTF-8 encoded JSON documents. Functions that may return this value: AwsIotJobs_GetPendingSync AwsIotJobs_StartNextSync AwsIotJobs_DescribeSync AwsIotJobs_UpdateSync AwsIotJobs_Wait May also be the value of a Jobs operation completion callback's AwsIotJobsCallbackParam_t.operation.result.
AWS_IOT_JOBS_INVALID_REQUEST	Jobs operation failed: The contents of the request were invalid. Functions that may return this value: AwsIotJobs_GetPendingSync AwsIotJobs_StartNextSync AwsIotJobs_DescribeSync AwsIotJobs_UpdateSync AwsIotJobs_Wait May also be the value of a Jobs operation completion callback's AwsIotJobsCallbackParam_t.operation.result.
AWS_IOT_JOBS_INVALID_STATE	Jobs operation failed: An update attempted to change the job execution to an invalid state. Functions that may return this value: AwsIotJobs_StartNextSync AwsIotJobs_UpdateSync AwsIotJobs_Wait May also be the value of a Jobs operation completion callback's AwsIotJobsCallbackParam_t.operation.result following a call to AwsIotJobs_StartNextAsync or AwsIotJobs_UpdateAsync.
AWS_IOT_JOBS_NOT_FOUND	Jobs operation failed: The specified job execution does not exist. Functions that may return this value: AwsIotJobs_DescribeSync AwsIotJobs_UpdateSync AwsIotJobs_Wait May also be the value of a Jobs operation completion callback's AwsIotJobsCallbackParam_t.operation.result following a call to AwsIotJobs_DescribeAsync or AwsIotJobs_UpdateAsync.
AWS_IOT_JOBS_VERSION_MISMATCH	Jobs operation failed: The Jobs service expected a version that did not match what was in the request. Functions that may return this value: AwsIotJobs_UpdateSync AwsIotJobs_Wait May also be the value of a Jobs operation completion callback's AwsIotJobsCallbackParam_t.operation.result following a call to AwsIotJobs_UpdateAsync.
AWS_IOT_JOBS_INTERNAL_ERROR	Jobs operation failed: The Jobs service encountered an internal error. Functions that may return this value: AwsIotJobs_GetPendingSync AwsIotJobs_StartNextSync AwsIotJobs_DescribeSync AwsIotJobs_UpdateSync AwsIotJobs_Wait May also be the value of a Jobs operation completion callback's AwsIotJobsCallbackParam_t.operation.result.
AWS_IOT_JOBS_THROTTLED	Jobs operation failed: The request was throttled. Functions that may return this value: AwsIotJobs_GetPendingSync AwsIotJobs_StartNextSync AwsIotJobs_DescribeSync AwsIotJobs_UpdateSync AwsIotJobs_Wait May also be the value of a Jobs operation completion callback's AwsIotJobsCallbackParam_t.operation.result.
AWS_IOT_JOBS_TERMINAL_STATE	Jobs operation failed: Attempt to describe a Job in a terminal state. Functions that may return this value: AwsIotJobs_DescribeSync AwsIotJobs_Wait May also be the value of a Jobs operation completion callback's AwsIotJobsCallbackParam_t.operation.result following a call to AwsIotJobs_DescribeAsync.

AwsIotJobState_t

enum AwsIotJobState_t

Possible states of jobs.

The function AwsIotJobs_StateName can be used to get a state's description.

See this page for more information on Job states.

Enumerator
AWS_IOT_JOB_STATE_QUEUED	A Job is queued and awaiting execution.
AWS_IOT_JOB_STATE_IN_PROGRESS	A Job is currently executing.
AWS_IOT_JOB_STATE_FAILED	A Job has failed. This is a terminal state.
AWS_IOT_JOB_STATE_SUCCEEDED	A Job has succeeded. This is a terminal state.
AWS_IOT_JOB_STATE_CANCELED	A Job was canceled. This is a terminal state.
AWS_IOT_JOB_STATE_TIMED_OUT	A Job's timer has expired. This is a terminal state. Jobs are considered timed out if they remain IN_PROGRESS for more than their inProgressTimeoutInMinutes property or a Job update was not sent within stepTimeoutInMinutes.
AWS_IOT_JOB_STATE_REJECTED	A Job was rejected by the device. This is a terminal state.
AWS_IOT_JOB_STATE_REMOVED	A Job was removed. This is a terminal state.

AwsIotJobsCallbackType_t

enum AwsIotJobsCallbackType_t

Types of Jobs library callbacks.

One of these values will be placed in AwsIotJobsCallbackParam_t.callbackType to identify the reason for invoking a callback function.

Enumerator
AWS_IOT_JOBS_GET_PENDING_COMPLETE	Callback invoked because a Jobs get pending completed.
AWS_IOT_JOBS_START_NEXT_COMPLETE	Callback invoked because a Jobs start next completed.
AWS_IOT_JOBS_DESCRIBE_COMPLETE	Callback invoked because a Jobs describe completed.
AWS_IOT_JOBS_UPDATE_COMPLETE	Callback invoked because a Jobs update completed.
AWS_IOT_JOBS_NOTIFY_PENDING_CALLBACK	Callback invoked for an incoming message on a Jobs notify-pending topic.
AWS_IOT_JOBS_NOTIFY_NEXT_CALLBACK	Callback invoked for an incoming message on a Jobs notify-next topic.