Functions for mapping between json and the AWS Iot Job data structures. More...

Functions
int	aws_iot_jobs_json_serialize_update_job_execution_request (char requestBuffer, size_t bufferSize, const AwsIotJobExecutionUpdateRequest request)
	Serialize a job execution update request into a json string.
int	aws_iot_jobs_json_serialize_client_token_only_request (char requestBuffer, size_t bufferSize, const char clientToken)
	Serialize a job API request that contains only a client token.
int	aws_iot_jobs_json_serialize_describe_job_execution_request (char requestBuffer, size_t bufferSize, const AwsIotDescribeJobExecutionRequest request)
	Serialize describe job execution request into json string.
int	aws_iot_jobs_json_serialize_start_next_job_execution_request (char requestBuffer, size_t bufferSize, const AwsIotStartNextPendingJobExecutionRequest request)
	Serialize start next job execution request into json string.

Detailed Description

Functions for mapping between json and the AWS Iot Job data structures.

Definition in file aws_iot_jobs_json.h.

Function Documentation

int aws_iot_jobs_json_serialize_client_token_only_request	(	char *	requestBuffer,
		size_t	bufferSize,
		const char *	clientToken
	)

Serialize a job API request that contains only a client token.

Parameters:

requestBuffer	buffer to contain the serialized request. If null this function will return the size of the buffer required
bufferSize	the size of the buffer. If this is smaller than the required length the string will be truncated to fit.
clientToken	the client token to use for the request.

Returns:: The size of the json string to store the serialized request or -1 if the request is invalid. Note that the return value should be checked against the size of the buffer and if its larger handle the fact that the string has been truncated.

Definition at line 129 of file aws_iot_jobs_json.c.

int aws_iot_jobs_json_serialize_describe_job_execution_request	(	char *	requestBuffer,
		size_t	bufferSize,
		const AwsIotDescribeJobExecutionRequest *	request
	)

Serialize describe job execution request into json string.

Parameters:

requestBuffer	buffer to contain the serialized request. If null this function will return the size of the buffer required
bufferSize	the size of the buffer. If this is smaller than the required length the string will be truncated to fit.
request	the request to serialize.

Returns:: The size of the json string to store the serialized request or -1 if the request is invalid. Note that the return value should be checked against the size of the buffer and if its larger handle the fact that the string has been truncated.

Definition at line 141 of file aws_iot_jobs_json.c.

int aws_iot_jobs_json_serialize_start_next_job_execution_request	(	char *	requestBuffer,
		size_t	bufferSize,
		const AwsIotStartNextPendingJobExecutionRequest *	request
	)

Serialize start next job execution request into json string.

Parameters:

requestBuffer	buffer to contain the serialized request. If null this function will return the size of the buffer required
bufferSize	the size of the buffer. If this is smaller than the required length the string will be truncated to fit.
request	the start-next request to serialize.

Returns:: The size of the json string to store the serialized request or -1 if the request is invalid. Note that the return value should be checked against the size of the buffer and if its larger handle the fact that the string has been truncated.

Definition at line 170 of file aws_iot_jobs_json.c.

int aws_iot_jobs_json_serialize_update_job_execution_request	(	char *	requestBuffer,
		size_t	bufferSize,
		const AwsIotJobExecutionUpdateRequest *	request
	)

Serialize a job execution update request into a json string.

Parameters:

requestBuffer	buffer to contain the serialized request. If null this function will return the size of the buffer required
bufferSize	the size of the buffer. If this is smaller than the required length the string will be truncated to fit. the request to serialize.

Returns:: The size of the json string to store the serialized request or -1 if the request is invalid. Note that the return value should be checked against the size of the buffer and if its larger handle the fact that the string has been truncated.

Definition at line 88 of file aws_iot_jobs_json.c.