AWS IoT Device SDK C++ v2: Aws::Iotjobs Namespace Reference

AWS IoT Device SDK C++ v2 1.14.0 AWS IoT Device SDK C++ v2

Namespaces | Classes | Typedefs | Enumerations
Aws::Iotjobs Namespace Reference

## Namespaces
namespace | JobStatusMarshaller
namespace | RejectedErrorCodeMarshaller

## Classes
class | DescribeJobExecutionRequest
class | DescribeJobExecutionResponse
class | DescribeJobExecutionSubscriptionRequest
class | GetPendingJobExecutionsRequest
class | GetPendingJobExecutionsResponse
class | GetPendingJobExecutionsSubscriptionRequest
class | IotJobsClient
class | JobExecutionData
class | JobExecutionsChangedEvent
class | JobExecutionsChangedSubscriptionRequest
class | JobExecutionState
class | JobExecutionSummary
class | NextJobExecutionChangedEvent
class | NextJobExecutionChangedSubscriptionRequest
class | RejectedError
class | StartNextJobExecutionResponse
class | StartNextPendingJobExecutionRequest
class | StartNextPendingJobExecutionSubscriptionRequest
class | UpdateJobExecutionRequest
class | UpdateJobExecutionResponse
class | UpdateJobExecutionSubscriptionRequest

## Typedefs
using | OnSubscribeComplete = std::function< void(int ioErr)>
using | OnPublishComplete = std::function< void(int ioErr)>
using | OnSubscribeToUpdateJobExecutionAcceptedResponse = std::function< void(Aws::Iotjobs::UpdateJobExecutionResponse *, int ioErr)>
using | OnSubscribeToGetPendingJobExecutionsRejectedResponse = std::function< void(Aws::Iotjobs::RejectedError *, int ioErr)>
using | OnSubscribeToDescribeJobExecutionAcceptedResponse = std::function< void(Aws::Iotjobs::DescribeJobExecutionResponse *, int ioErr)>
using | OnSubscribeToDescribeJobExecutionRejectedResponse = std::function< void(Aws::Iotjobs::RejectedError *, int ioErr)>
using | OnSubscribeToUpdateJobExecutionRejectedResponse = std::function< void(Aws::Iotjobs::RejectedError *, int ioErr)>
using | OnSubscribeToJobExecutionsChangedEventsResponse = std::function< void(Aws::Iotjobs::JobExecutionsChangedEvent *, int ioErr)>
using | OnSubscribeToStartNextPendingJobExecutionRejectedResponse = std::function< void(Aws::Iotjobs::RejectedError *, int ioErr)>
using | OnSubscribeToNextJobExecutionChangedEventsResponse = std::function< void(Aws::Iotjobs::NextJobExecutionChangedEvent *, int ioErr)>
using | OnSubscribeToGetPendingJobExecutionsAcceptedResponse = std::function< void(Aws::Iotjobs::GetPendingJobExecutionsResponse *, int ioErr)>
using | OnSubscribeToStartNextPendingJobExecutionAcceptedResponse = std::function< void(Aws::Iotjobs::StartNextJobExecutionResponse *, int ioErr)>

## Enumerations
enum class | JobStatus { QUEUED , IN_PROGRESS , TIMED_OUT , FAILED , SUCCEEDED , CANCELED , REJECTED , REMOVED }
enum class | RejectedErrorCode { InvalidTopic , InvalidJson , InvalidRequest , InvalidStateTransition , ResourceNotFound , VersionMismatch , InternalError , RequestThrottled , TerminalStateReached }

## Typedef Documentation

## ◆ OnPublishComplete

using Aws::Iotjobs::OnPublishComplete = typedef std::function<void(int ioErr)>

## ◆ OnSubscribeComplete

using Aws::Iotjobs::OnSubscribeComplete = typedef std::function<void(int ioErr)>

## ◆ OnSubscribeToDescribeJobExecutionAcceptedResponse

using Aws::Iotjobs::OnSubscribeToDescribeJobExecutionAcceptedResponse = typedef std::function<void(Aws::Iotjobs::DescribeJobExecutionResponse *, int ioErr)>

## ◆ OnSubscribeToDescribeJobExecutionRejectedResponse

using Aws::Iotjobs::OnSubscribeToDescribeJobExecutionRejectedResponse = typedef std::function<void(Aws::Iotjobs::RejectedError *, int ioErr)>

## ◆ OnSubscribeToGetPendingJobExecutionsAcceptedResponse

using Aws::Iotjobs::OnSubscribeToGetPendingJobExecutionsAcceptedResponse = typedef std::function<void(Aws::Iotjobs::GetPendingJobExecutionsResponse *, int ioErr)>

## ◆ OnSubscribeToGetPendingJobExecutionsRejectedResponse

using Aws::Iotjobs::OnSubscribeToGetPendingJobExecutionsRejectedResponse = typedef std::function<void(Aws::Iotjobs::RejectedError *, int ioErr)>

## ◆ OnSubscribeToJobExecutionsChangedEventsResponse

using Aws::Iotjobs::OnSubscribeToJobExecutionsChangedEventsResponse = typedef std::function<void(Aws::Iotjobs::JobExecutionsChangedEvent *, int ioErr)>

## ◆ OnSubscribeToNextJobExecutionChangedEventsResponse

using Aws::Iotjobs::OnSubscribeToNextJobExecutionChangedEventsResponse = typedef std::function<void(Aws::Iotjobs::NextJobExecutionChangedEvent *, int ioErr)>

## ◆ OnSubscribeToStartNextPendingJobExecutionAcceptedResponse

using Aws::Iotjobs::OnSubscribeToStartNextPendingJobExecutionAcceptedResponse = typedef std::function<void(Aws::Iotjobs::StartNextJobExecutionResponse *, int ioErr)>

## ◆ OnSubscribeToStartNextPendingJobExecutionRejectedResponse

using Aws::Iotjobs::OnSubscribeToStartNextPendingJobExecutionRejectedResponse = typedef std::function<void(Aws::Iotjobs::RejectedError *, int ioErr)>

## ◆ OnSubscribeToUpdateJobExecutionAcceptedResponse

using Aws::Iotjobs::OnSubscribeToUpdateJobExecutionAcceptedResponse = typedef std::function<void(Aws::Iotjobs::UpdateJobExecutionResponse *, int ioErr)>

## ◆ OnSubscribeToUpdateJobExecutionRejectedResponse

using Aws::Iotjobs::OnSubscribeToUpdateJobExecutionRejectedResponse = typedef std::function<void(Aws::Iotjobs::RejectedError *, int ioErr)>

## Enumeration Type Documentation

## ◆ JobStatus

enum class Aws::Iotjobs::JobStatus
| strong

The status of the job execution.

Enumerator
QUEUED |
IN_PROGRESS |
TIMED_OUT |
FAILED |
SUCCEEDED |
CANCELED |
REJECTED |
REMOVED |

## ◆ RejectedErrorCode

enum class Aws::Iotjobs::RejectedErrorCode
| strong

A value indicating the kind of error encountered while processing an AWS IoT Jobs request

Enumerator
InvalidTopic | The request was sent to a topic in the AWS IoT Jobs namespace that does not map to any API.
InvalidJson | The contents of the request could not be interpreted as valid UTF-8-encoded JSON.
InvalidRequest | The contents of the request were invalid. The message contains details about the error.
InvalidStateTransition | An update attempted to change the job execution to a state that is invalid because of the job execution's current state. In this case, the body of the error message also contains the executionState field.
ResourceNotFound | The JobExecution specified by the request topic does not exist.
VersionMismatch | The expected version specified in the request does not match the version of the job execution in the AWS IoT Jobs service. In this case, the body of the error message also contains the executionState field.
InternalError | There was an internal error during the processing of the request.
RequestThrottled | The request was throttled.
TerminalStateReached | Occurs when a command to describe a job is performed on a job that is in a terminal state.