AWS IoT Device SDK C++ v2  1.36.0
AWS IoT Device SDK C++ v2
Public Member Functions | Public Attributes | List of all members
Aws::Iotjobs::V2ErrorResponse Class Referencefinal

#include <V2ErrorResponse.h>

Public Member Functions

 V2ErrorResponse ()=default
 
 V2ErrorResponse (const Crt::JsonView &doc)
 
V2ErrorResponseoperator= (const Crt::JsonView &doc)
 
void SerializeToObject (Crt::JsonObject &doc) const
 

Public Attributes

Aws::Crt::Optional< Aws::Crt::StringClientToken
 
Aws::Crt::Optional< Aws::Iotjobs::RejectedErrorCodeCode
 
Aws::Crt::Optional< Aws::Crt::StringMessage
 
Aws::Crt::Optional< Aws::Crt::DateTimeTimestamp
 
Aws::Crt::Optional< Aws::Iotjobs::JobExecutionStateExecutionState
 

Detailed Description

Response document containing details about a failed request.

Constructor & Destructor Documentation

◆ V2ErrorResponse() [1/2]

Aws::Iotjobs::V2ErrorResponse::V2ErrorResponse ( )
default

◆ V2ErrorResponse() [2/2]

Aws::Iotjobs::V2ErrorResponse::V2ErrorResponse ( const Crt::JsonView doc)

Member Function Documentation

◆ operator=()

V2ErrorResponse & Aws::Iotjobs::V2ErrorResponse::operator= ( const Crt::JsonView doc)

◆ SerializeToObject()

void Aws::Iotjobs::V2ErrorResponse::SerializeToObject ( Crt::JsonObject doc) const

Member Data Documentation

◆ ClientToken

Aws::Crt::Optional<Aws::Crt::String> Aws::Iotjobs::V2ErrorResponse::ClientToken

Opaque token that can correlate this response to the original request.

◆ Code

Aws::Crt::Optional<Aws::Iotjobs::RejectedErrorCode> Aws::Iotjobs::V2ErrorResponse::Code

Indicates the type of error.

◆ ExecutionState

Aws::Crt::Optional<Aws::Iotjobs::JobExecutionState> Aws::Iotjobs::V2ErrorResponse::ExecutionState

A JobExecutionState object. This field is included only when the code field has the value InvalidStateTransition or VersionMismatch.

◆ Message

Aws::Crt::Optional<Aws::Crt::String> Aws::Iotjobs::V2ErrorResponse::Message

A text message that provides additional information.

◆ Timestamp

Aws::Crt::Optional<Aws::Crt::DateTime> Aws::Iotjobs::V2ErrorResponse::Timestamp

The date and time the response was generated by AWS IoT.


The documentation for this class was generated from the following files: