Aws::Iotjobs Namespace Reference

Namespaces
namespace	JobStatusMarshaller
namespace	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
using	OnSubscribeToDescribeJobExecutionRejectedResponse
using	OnSubscribeToGetPendingJobExecutionsAcceptedResponse
using	OnSubscribeToGetPendingJobExecutionsRejectedResponse
using	OnSubscribeToJobExecutionsChangedEventsResponse
using	OnSubscribeToNextJobExecutionChangedEventsResponse
using	OnSubscribeToStartNextPendingJobExecutionAcceptedResponse
using	OnSubscribeToStartNextPendingJobExecutionRejectedResponse
using	OnSubscribeToUpdateJobExecutionAcceptedResponse
using	OnSubscribeToUpdateJobExecutionRejectedResponse
using	DescribeJobExecutionResult
using	DescribeJobExecutionResultHandler = std::function<void(DescribeJobExecutionResult &&)>
using	GetPendingJobExecutionsResult
using	GetPendingJobExecutionsResultHandler = std::function<void(GetPendingJobExecutionsResult &&)>
using	StartNextPendingJobExecutionResult
using	StartNextPendingJobExecutionResultHandler = std::function<void(StartNextPendingJobExecutionResult &&)>
using	UpdateJobExecutionResult
using	UpdateJobExecutionResultHandler = std::function<void(UpdateJobExecutionResult &&)>

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 }

Functions
AWS_IOTJOBS_API std::shared_ptr< IClientV2 >	NewClientFrom5 (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< IClientV2 >	NewClientFrom311 (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

using Aws::Iotjobs::DescribeJobExecutionResult

Initial value:

 
Aws::Iot::RequestResponse::Result<DescribeJobExecutionResponse, ServiceErrorV2<V2ErrorResponse>>

DescribeJobExecutionResultHandler

using Aws::Iotjobs::DescribeJobExecutionResultHandler = std::function<void(DescribeJobExecutionResult &&)>

GetPendingJobExecutionsResult

using Aws::Iotjobs::GetPendingJobExecutionsResult

Initial value:

 
Aws::Iot::RequestResponse::Result<GetPendingJobExecutionsResponse, ServiceErrorV2<V2ErrorResponse>>

GetPendingJobExecutionsResultHandler

using Aws::Iotjobs::GetPendingJobExecutionsResultHandler = std::function<void(GetPendingJobExecutionsResult &&)>

OnPublishComplete

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

OnSubscribeComplete

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

OnSubscribeToDescribeJobExecutionAcceptedResponse

using Aws::Iotjobs::OnSubscribeToDescribeJobExecutionAcceptedResponse

Initial value:

 
std::function<void(Aws::Iotjobs::DescribeJobExecutionResponse *, int ioErr)>

OnSubscribeToDescribeJobExecutionRejectedResponse

using Aws::Iotjobs::OnSubscribeToDescribeJobExecutionRejectedResponse

Initial value:

 
std::function<void(Aws::Iotjobs::RejectedError *, int ioErr)>

OnSubscribeToGetPendingJobExecutionsAcceptedResponse

using Aws::Iotjobs::OnSubscribeToGetPendingJobExecutionsAcceptedResponse

Initial value:

 
std::function<void(Aws::Iotjobs::GetPendingJobExecutionsResponse *, int ioErr)>

OnSubscribeToGetPendingJobExecutionsRejectedResponse

using Aws::Iotjobs::OnSubscribeToGetPendingJobExecutionsRejectedResponse

Initial value:

 
std::function<void(Aws::Iotjobs::RejectedError *, int ioErr)>

OnSubscribeToJobExecutionsChangedEventsResponse

using Aws::Iotjobs::OnSubscribeToJobExecutionsChangedEventsResponse

Initial value:

 
std::function<void(Aws::Iotjobs::JobExecutionsChangedEvent *, int ioErr)>

OnSubscribeToNextJobExecutionChangedEventsResponse

using Aws::Iotjobs::OnSubscribeToNextJobExecutionChangedEventsResponse

Initial value:

 
std::function<void(Aws::Iotjobs::NextJobExecutionChangedEvent *, int ioErr)>

OnSubscribeToStartNextPendingJobExecutionAcceptedResponse

using Aws::Iotjobs::OnSubscribeToStartNextPendingJobExecutionAcceptedResponse

Initial value:

 
std::function<void(Aws::Iotjobs::StartNextJobExecutionResponse *, int ioErr)>

OnSubscribeToStartNextPendingJobExecutionRejectedResponse

using Aws::Iotjobs::OnSubscribeToStartNextPendingJobExecutionRejectedResponse

Initial value:

 
std::function<void(Aws::Iotjobs::RejectedError *, int ioErr)>

OnSubscribeToUpdateJobExecutionAcceptedResponse

using Aws::Iotjobs::OnSubscribeToUpdateJobExecutionAcceptedResponse

Initial value:

 
std::function<void(Aws::Iotjobs::UpdateJobExecutionResponse *, int ioErr)>

OnSubscribeToUpdateJobExecutionRejectedResponse

using Aws::Iotjobs::OnSubscribeToUpdateJobExecutionRejectedResponse

Initial value:

 
std::function<void(Aws::Iotjobs::RejectedError *, int ioErr)>

StartNextPendingJobExecutionResult

using Aws::Iotjobs::StartNextPendingJobExecutionResult

Initial value:

 
Aws::Iot::RequestResponse::Result<StartNextJobExecutionResponse, ServiceErrorV2<V2ErrorResponse>>

StartNextPendingJobExecutionResultHandler

using Aws::Iotjobs::StartNextPendingJobExecutionResultHandler = std::function<void(StartNextPendingJobExecutionResult &&)>

UpdateJobExecutionResult

using Aws::Iotjobs::UpdateJobExecutionResult

Initial value:

 
Aws::Iot::RequestResponse::Result<UpdateJobExecutionResponse, ServiceErrorV2<V2ErrorResponse>>

UpdateJobExecutionResultHandler

using Aws::Iotjobs::UpdateJobExecutionResultHandler = std::function<void(UpdateJobExecutionResult &&)>

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.

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

protocolClient	MQTT client to use as transport
options	request-response MQTT client configuration options
allocator	memory 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

protocolClient	MQTT client to use as transport
options	request-response MQTT client configuration options
allocator	memory allocator to use for all client functionality

Returns

a new service client

s_applyModeledErrorToHandler()

template<typename R, typename E>

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

static

s_applyUnmodeledErrorToHandler()

template<typename R, typename E>

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

static

s_DescribeJobExecutionResponseHandler()

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()

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]

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

static

s_initModeledEvent() [2/2]

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

static

s_StartNextPendingJobExecutionResponseHandler()

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()

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

static