AWS IoT Device SDK C++ v2  1.36.0
AWS IoT Device SDK C++ v2
Namespaces | Classes | Typedefs | Enumerations | Functions
Aws::Iotjobs Namespace Reference

Namespaces

 JobStatusMarshaller
 
 RejectedErrorCodeMarshaller
 

Classes

class  ClientV2
 
class  DescribeJobExecutionRequest
 
class  DescribeJobExecutionResponse
 
class  DescribeJobExecutionSubscriptionRequest
 
class  GetPendingJobExecutionsRequest
 
class  GetPendingJobExecutionsResponse
 
class  GetPendingJobExecutionsSubscriptionRequest
 
class  IClientV2
 
class  IotJobsClient
 
class  JobExecutionData
 
class  JobExecutionsChangedEvent
 
class  JobExecutionsChangedSubscriptionRequest
 
class  JobExecutionState
 
class  JobExecutionSummary
 
class  NextJobExecutionChangedEvent
 
class  NextJobExecutionChangedSubscriptionRequest
 
class  RejectedError
 
class  ServiceErrorV2
 
class  ServiceStreamingOperation
 
class  StartNextJobExecutionResponse
 
class  StartNextPendingJobExecutionRequest
 
class  StartNextPendingJobExecutionSubscriptionRequest
 
class  UpdateJobExecutionRequest
 
class  UpdateJobExecutionResponse
 
class  UpdateJobExecutionSubscriptionRequest
 
class  V2ErrorResponse
 

Typedefs

using OnSubscribeComplete = std::function< void(int ioErr)>
 
using OnPublishComplete = std::function< void(int ioErr)>
 
using OnSubscribeToDescribeJobExecutionAcceptedResponse = std::function< void(Aws::Iotjobs::DescribeJobExecutionResponse *, int ioErr)>
 
using OnSubscribeToDescribeJobExecutionRejectedResponse = std::function< void(Aws::Iotjobs::RejectedError *, int ioErr)>
 
using OnSubscribeToGetPendingJobExecutionsAcceptedResponse = std::function< void(Aws::Iotjobs::GetPendingJobExecutionsResponse *, int ioErr)>
 
using OnSubscribeToGetPendingJobExecutionsRejectedResponse = std::function< void(Aws::Iotjobs::RejectedError *, int ioErr)>
 
using OnSubscribeToJobExecutionsChangedEventsResponse = std::function< void(Aws::Iotjobs::JobExecutionsChangedEvent *, int ioErr)>
 
using OnSubscribeToNextJobExecutionChangedEventsResponse = std::function< void(Aws::Iotjobs::NextJobExecutionChangedEvent *, int ioErr)>
 
using OnSubscribeToStartNextPendingJobExecutionAcceptedResponse = std::function< void(Aws::Iotjobs::StartNextJobExecutionResponse *, int ioErr)>
 
using OnSubscribeToStartNextPendingJobExecutionRejectedResponse = std::function< void(Aws::Iotjobs::RejectedError *, int ioErr)>
 
using OnSubscribeToUpdateJobExecutionAcceptedResponse = std::function< void(Aws::Iotjobs::UpdateJobExecutionResponse *, int ioErr)>
 
using OnSubscribeToUpdateJobExecutionRejectedResponse = std::function< void(Aws::Iotjobs::RejectedError *, int ioErr)>
 
using DescribeJobExecutionResult = Aws::Iot::RequestResponse::Result< DescribeJobExecutionResponse, ServiceErrorV2< V2ErrorResponse > >
 
using DescribeJobExecutionResultHandler = std::function< void(DescribeJobExecutionResult &&)>
 
using GetPendingJobExecutionsResult = Aws::Iot::RequestResponse::Result< GetPendingJobExecutionsResponse, ServiceErrorV2< V2ErrorResponse > >
 
using GetPendingJobExecutionsResultHandler = std::function< void(GetPendingJobExecutionsResult &&)>
 
using StartNextPendingJobExecutionResult = Aws::Iot::RequestResponse::Result< StartNextJobExecutionResponse, ServiceErrorV2< V2ErrorResponse > >
 
using StartNextPendingJobExecutionResultHandler = std::function< void(StartNextPendingJobExecutionResult &&)>
 
using UpdateJobExecutionResult = Aws::Iot::RequestResponse::Result< UpdateJobExecutionResponse, ServiceErrorV2< V2ErrorResponse > >
 
using UpdateJobExecutionResultHandler = std::function< void(UpdateJobExecutionResult &&)>
 

Enumerations

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

Functions

AWS_IOTJOBS_API std::shared_ptr< IClientV2NewClientFrom5 (const Aws::Crt::Mqtt5::Mqtt5Client &protocolClient, const Aws::Iot::RequestResponse::RequestResponseClientOptions &options, Aws::Crt::Allocator *allocator=Aws::Crt::ApiAllocator())
 
AWS_IOTJOBS_API std::shared_ptr< IClientV2NewClientFrom311 (const Aws::Crt::Mqtt::MqttConnection &protocolClient, const Aws::Iot::RequestResponse::RequestResponseClientOptions &options, Aws::Crt::Allocator *allocator=Aws::Crt::ApiAllocator())
 
template<typename R , typename E >
static void s_applyUnmodeledErrorToHandler (const std::function< void(R &&)> &handler, int errorCode)
 
template<typename R , typename E >
static void s_applyModeledErrorToHandler (const std::function< void(R &&)> &handler, E &&modeledError)
 
static void s_DescribeJobExecutionResponseHandler (Aws::Iot::RequestResponse::UnmodeledResult &&result, const DescribeJobExecutionResultHandler &handler, const Aws::Crt::String &successPathTopic, const Aws::Crt::String &failurePathTopic)
 
static void s_GetPendingJobExecutionsResponseHandler (Aws::Iot::RequestResponse::UnmodeledResult &&result, const GetPendingJobExecutionsResultHandler &handler, const Aws::Crt::String &successPathTopic, const Aws::Crt::String &failurePathTopic)
 
static void s_StartNextPendingJobExecutionResponseHandler (Aws::Iot::RequestResponse::UnmodeledResult &&result, const StartNextPendingJobExecutionResultHandler &handler, const Aws::Crt::String &successPathTopic, const Aws::Crt::String &failurePathTopic)
 
static void s_UpdateJobExecutionResponseHandler (Aws::Iot::RequestResponse::UnmodeledResult &&result, const UpdateJobExecutionResultHandler &handler, const Aws::Crt::String &successPathTopic, const Aws::Crt::String &failurePathTopic)
 
static bool s_initModeledEvent (const Aws::Iot::RequestResponse::IncomingPublishEvent &publishEvent, NextJobExecutionChangedEvent &modeledEvent)
 
static bool s_initModeledEvent (const Aws::Iot::RequestResponse::IncomingPublishEvent &publishEvent, JobExecutionsChangedEvent &modeledEvent)
 

Typedef Documentation

◆ DescribeJobExecutionResult

◆ DescribeJobExecutionResultHandler

◆ GetPendingJobExecutionsResult

◆ GetPendingJobExecutionsResultHandler

◆ OnPublishComplete

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

◆ OnSubscribeComplete

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

◆ OnSubscribeToDescribeJobExecutionAcceptedResponse

◆ OnSubscribeToDescribeJobExecutionRejectedResponse

◆ OnSubscribeToGetPendingJobExecutionsAcceptedResponse

◆ OnSubscribeToGetPendingJobExecutionsRejectedResponse

◆ OnSubscribeToJobExecutionsChangedEventsResponse

◆ OnSubscribeToNextJobExecutionChangedEventsResponse

◆ OnSubscribeToStartNextPendingJobExecutionAcceptedResponse

◆ OnSubscribeToStartNextPendingJobExecutionRejectedResponse

◆ OnSubscribeToUpdateJobExecutionAcceptedResponse

◆ OnSubscribeToUpdateJobExecutionRejectedResponse

◆ StartNextPendingJobExecutionResult

◆ StartNextPendingJobExecutionResultHandler

◆ UpdateJobExecutionResult

◆ UpdateJobExecutionResultHandler

Enumeration Type Documentation

◆ JobStatus

The status of the job execution.

Enumerator
QUEUED 
IN_PROGRESS 
TIMED_OUT 
FAILED 
SUCCEEDED 
CANCELED 
REJECTED 
REMOVED 

◆ RejectedErrorCode

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.

Function Documentation

◆ NewClientFrom311()

std::shared_ptr< IClientV2 > Aws::Iotjobs::NewClientFrom311 ( const Aws::Crt::Mqtt::MqttConnection protocolClient,
const Aws::Iot::RequestResponse::RequestResponseClientOptions options,
Aws::Crt::Allocator allocator = Aws::Crt::ApiAllocator() 
)

Creates a new service client that uses an SDK MQTT311 client for transport.

Parameters
protocolClientMQTT client to use as transport
optionsrequest-response MQTT client configuration options
allocatormemory allocator to use for all client functionality
Returns
a new service client

◆ NewClientFrom5()

std::shared_ptr< IClientV2 > Aws::Iotjobs::NewClientFrom5 ( const Aws::Crt::Mqtt5::Mqtt5Client protocolClient,
const Aws::Iot::RequestResponse::RequestResponseClientOptions options,
Aws::Crt::Allocator allocator = Aws::Crt::ApiAllocator() 
)

Creates a new service client that uses an SDK MQTT5 client for transport.

Parameters
protocolClientMQTT client to use as transport
optionsrequest-response MQTT client configuration options
allocatormemory allocator to use for all client functionality
Returns
a new service client

◆ s_applyModeledErrorToHandler()

template<typename R , typename E >
static void Aws::Iotjobs::s_applyModeledErrorToHandler ( const std::function< void(R &&)> &  handler,
E &&  modeledError 
)
static

◆ s_applyUnmodeledErrorToHandler()

template<typename R , typename E >
static void Aws::Iotjobs::s_applyUnmodeledErrorToHandler ( const std::function< void(R &&)> &  handler,
int  errorCode 
)
static

◆ s_DescribeJobExecutionResponseHandler()

static void Aws::Iotjobs::s_DescribeJobExecutionResponseHandler ( Aws::Iot::RequestResponse::UnmodeledResult &&  result,
const DescribeJobExecutionResultHandler handler,
const Aws::Crt::String successPathTopic,
const Aws::Crt::String failurePathTopic 
)
static

◆ s_GetPendingJobExecutionsResponseHandler()

static void Aws::Iotjobs::s_GetPendingJobExecutionsResponseHandler ( Aws::Iot::RequestResponse::UnmodeledResult &&  result,
const GetPendingJobExecutionsResultHandler handler,
const Aws::Crt::String successPathTopic,
const Aws::Crt::String failurePathTopic 
)
static

◆ s_initModeledEvent() [1/2]

static bool Aws::Iotjobs::s_initModeledEvent ( const Aws::Iot::RequestResponse::IncomingPublishEvent publishEvent,
JobExecutionsChangedEvent modeledEvent 
)
static

◆ s_initModeledEvent() [2/2]

static bool Aws::Iotjobs::s_initModeledEvent ( const Aws::Iot::RequestResponse::IncomingPublishEvent publishEvent,
NextJobExecutionChangedEvent modeledEvent 
)
static

◆ s_StartNextPendingJobExecutionResponseHandler()

static void Aws::Iotjobs::s_StartNextPendingJobExecutionResponseHandler ( Aws::Iot::RequestResponse::UnmodeledResult &&  result,
const StartNextPendingJobExecutionResultHandler handler,
const Aws::Crt::String successPathTopic,
const Aws::Crt::String failurePathTopic 
)
static

◆ s_UpdateJobExecutionResponseHandler()

static void Aws::Iotjobs::s_UpdateJobExecutionResponseHandler ( Aws::Iot::RequestResponse::UnmodeledResult &&  result,
const UpdateJobExecutionResultHandler handler,
const Aws::Crt::String successPathTopic,
const Aws::Crt::String failurePathTopic 
)
static