AwsIotJobsRequestInfo_t Struct Reference

Common information provided to Jobs requests. More...

#include <aws_iot_jobs_types.h>

Data Fields
IotMqttConnection_t	mqttConnection
	The MQTT connection to use for the Jobs request.
IotMqttQos_t	qos
	QoS when sending the Jobs command. See IotMqttPublishInfo_t.qos.
uint32_t	retryLimit
	Maximum number of retries for the Jobs command. See IotMqttPublishInfo_t.retryLimit.
uint32_t	retryMs
	First retry time for the Jobs command. See IotMqttPublishInfo_t.retryMs.
void *(*	mallocResponse )(size_t)
	Function to allocate memory for an incoming response. More...
const char *	pThingName
	The Thing Name associated with the Job.
size_t	thingNameLength
	Length of AwsIotJobsRequestInfo_t.pThingName.
const char *	pJobId
	The Job ID to update. More...
size_t	jobIdLength
	Length of AwsIotJobsRequestInfo_t.pJobId. More...
const char *	pClientToken
	An arbitrary string that identifies this Job update to the Jobs service. More...
size_t	clientTokenLength
	Length of AwsIotJobsRequestInfo_t.pClientToken.

Detailed Description

Common information provided to Jobs requests.

Parameter for: AwsIotJobs_GetPendingAsync, AwsIotJobs_GetPendingSync, AwsIotJobs_StartNextAsync, AwsIotJobs_StartNextSync AwsIotJobs_DescribeAsync, AwsIotJobs_DescribeSync, AwsIotJobs_UpdateAsync, AwsIotJobs_UpdateSync

All instances of AwsIotJobsRequestInfo_t should be initialized with AWS_IOT_JOBS_REQUEST_INFO_INITIALIZER.

Field Documentation

mallocResponse

void*( * AwsIotJobsRequestInfo_t::mallocResponse) (size_t)

Function to allocate memory for an incoming response.

This only needs to be set if AWS_IOT_JOBS_FLAG_WAITABLE is passed.

pJobId

const char* AwsIotJobsRequestInfo_t::pJobId

The Job ID to update.

This may be set to AWS_IOT_JOBS_NEXT_JOB to update the next pending Job. When using AWS_IOT_JOBS_NEXT_JOB, AwsIotJobsRequestInfo_t.jobIdLength should be set to AWS_IOT_JOBS_NEXT_JOB_LENGTH.

This parameter is ignored for calls to AwsIotJobs_GetPendingAsync, AwsIotJobs_GetPendingSync, AwsIotJobs_StartNextAsync, and AwsIotJobs_StartNextSync.

jobIdLength

size_t AwsIotJobsRequestInfo_t::jobIdLength

Length of AwsIotJobsRequestInfo_t.pJobId.

This parameter is ignored for calls to AwsIotJobs_GetPendingAsync, AwsIotJobs_GetPendingSync, AwsIotJobs_StartNextAsync, and AwsIotJobs_StartNextSync.

pClientToken

const char* AwsIotJobsRequestInfo_t::pClientToken

An arbitrary string that identifies this Job update to the Jobs service.

The recommended value is AWS_IOT_JOBS_CLIENT_TOKEN_AUTOGENERATE.

---

The documentation for this struct was generated from the following file:

• aws_iot_jobs_types.h