AwsIotJobs_DescribeSync

Get detailed information about a job execution with a timeout for receiving the response.

AwsIotJobsError_t AwsIotJobs_DescribeSync( const AwsIotJobsRequestInfo_t * pRequestInfo,
                                           int32_t executionNumber,
                                           bool includeJobDocument,
                                           uint32_t flags,
                                           uint32_t timeoutMs,
                                           AwsIotJobsResponse_t * const pJobsResponse );

This function queues a Jobs DESCRIBE, then waits for the result. Internally, this function is a call to AwsIotJobs_DescribeAsync followed by AwsIotJobs_Wait. See AwsIotJobs_DescribeAsync for more information on the Jobs DESCRIBE command.

Parameters

[in]	pRequestInfo	Jobs request parameters.
[in]	executionNumber	The execution number to describe. Optional; pass AWS_IOT_JOBS_NO_EXECUTION_NUMBER to ignore.
[in]	includeJobDocument	Whether the response should include the full Job document.
[in]	flags	Flags which modify the behavior of the Jobs request. See Jobs Function Flags.
[in]	timeoutMs	If a response is not received within this timeout, this function returns AWS_IOT_JOBS_TIMEOUT.
[out]	pJobsResponse	The response received from the Jobs service.

Returns

One of the following:

• AWS_IOT_JOBS_SUCCESS
• AWS_IOT_JOBS_NOT_INITIALIZED
• AWS_IOT_JOBS_BAD_PARAMETER
• AWS_IOT_JOBS_NO_MEMORY
• AWS_IOT_JOBS_MQTT_ERROR
• AWS_IOT_JOBS_BAD_RESPONSE
• AWS_IOT_JOBS_TIMEOUT
• A Jobs failure reason between AWS_IOT_JOBS_INVALID_TOPIC and AWS_IOT_JOBS_TERMINAL_STATE.