Aws::Iotcommands::UpdateCommandExecutionRequest Class Reference

#include <UpdateCommandExecutionRequest.h>

Public Member Functions
	UpdateCommandExecutionRequest ()=default
	UpdateCommandExecutionRequest (const Crt::JsonView &doc)
UpdateCommandExecutionRequest &	operator= (const Crt::JsonView &doc)
void	SerializeToObject (Crt::JsonObject &doc) const

Public Attributes
Aws::Crt::Optional< Aws::Iotcommands::DeviceType >	DeviceType
Aws::Crt::Optional< Aws::Crt::String >	DeviceId
Aws::Crt::Optional< Aws::Crt::String >	ExecutionId
Aws::Crt::Optional< Aws::Iotcommands::CommandExecutionStatus >	Status
Aws::Crt::Optional< Aws::Iotcommands::StatusReason >	StatusReason
Aws::Crt::Optional< Aws::Crt::Map< Aws::Crt::String, Aws::Iotcommands::CommandExecutionResult > >	Result

Detailed Description

Data needed to make an UpdateCommandExecution request.

Constructor & Destructor Documentation

UpdateCommandExecutionRequest() [1/2]

Aws::Iotcommands::UpdateCommandExecutionRequest::UpdateCommandExecutionRequest ( )

default

UpdateCommandExecutionRequest() [2/2]

Aws::Iotcommands::UpdateCommandExecutionRequest::UpdateCommandExecutionRequest

(

const Crt::JsonView &

doc

)

Member Function Documentation

operator=()

UpdateCommandExecutionRequest & Aws::Iotcommands::UpdateCommandExecutionRequest::operator=

(

const Crt::JsonView &

doc

)

SerializeToObject()

void Aws::Iotcommands::UpdateCommandExecutionRequest::SerializeToObject

(

Crt::JsonObject &

doc

)

const

Member Data Documentation

DeviceId

Aws::Crt::Optional<Aws::Crt::String> Aws::Iotcommands::UpdateCommandExecutionRequest::DeviceId

Depending on device type value, this field is either an IoT Thing name or a client ID.

DeviceType

Aws::Crt::Optional<Aws::Iotcommands::DeviceType> Aws::Iotcommands::UpdateCommandExecutionRequest::DeviceType

The type of a target device. Determine if the device should subscribe for commands addressed to an IoT Thing or MQTT client.

ExecutionId

Aws::Crt::Optional<Aws::Crt::String> Aws::Iotcommands::UpdateCommandExecutionRequest::ExecutionId

ID of the command execution that needs to be updated.

Result

Aws::Crt::Optional<Aws::Crt::Map<Aws::Crt::String, Aws::Iotcommands::CommandExecutionResult> > Aws::Iotcommands::UpdateCommandExecutionRequest::Result

The result value for the current state of the command execution. The status provides information about the progress of the command execution. The device can use the result field to share additional details about the execution such as a return value of a remote function call.

Status

Aws::Crt::Optional<Aws::Iotcommands::CommandExecutionStatus> Aws::Iotcommands::UpdateCommandExecutionRequest::Status

The status of the command execution.

StatusReason

Aws::Crt::Optional<Aws::Iotcommands::StatusReason> Aws::Iotcommands::UpdateCommandExecutionRequest::StatusReason

A reason for the updated status. Can provide additional information on failures. Should be used when status is one of the following: FAILED, REJECTED, TIMED_OUT.

---

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

• commands/include/aws/iotcommands/UpdateCommandExecutionRequest.h
• commands/source/UpdateCommandExecutionRequest.cpp