Module Values_1.GetCommandExecutionResponseSource

Gets information about the specific command execution on a single device.

Sourcetype nonrec t = {
  1. executionId : Values_0.CommandExecutionId.t option;
    (*

    The unique identifier of the command execution.

    *)
  2. commandArn : Values_0.CommandArn.t option;
    (*

    The Amazon Resource Number (ARN) of the command. For example, arn:aws:iot:<region>:<accountid>:command/<commandId>

    *)
  3. targetArn : Values_0.TargetArn.t option;
    (*

    The Amazon Resource Number (ARN) of the device on which the command execution is being performed.

    *)
  4. status : Values_0.CommandExecutionStatus.t option;
    (*

    The status of the command execution. After your devices receive the command and start performing the operations specified in the command, it can use the UpdateCommandExecution MQTT API to update the status information.

    *)
  5. statusReason : Values_0.StatusReason.t option;
    (*

    Your devices can use this parameter to provide additional context about the status of a command execution using a reason code and description.

    *)
  6. result : Values_0.CommandExecutionResultMap.t option;
    (*

    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. If you use the AWS-IoT-FleetWise namespace, then this field is not applicable in the API response.

    *)
  7. parameters : Values_0.CommandExecutionParameterMap.t option;
    (*

    The list of parameters that the StartCommandExecution API used when performing the command on the device.

    *)
  8. executionTimeoutSeconds : Values_0.CommandExecutionTimeoutInSeconds.t option;
    (*

    Specifies the amount of time in seconds that the device can take to finish a command execution. A timer starts when the command execution is created. If the command execution status is not set to another terminal state before the timer expires, it will automatically update to TIMED_OUT.

    *)
  9. createdAt : Values_0.DateType.t option;
    (*

    The timestamp, when the command execution was created.

    *)
  10. lastUpdatedAt : Values_0.DateType.t option;
    (*

    The timestamp, when the command execution was last updated.

    *)
  11. startedAt : Values_0.DateType.t option;
    (*

    The timestamp, when the command execution was started.

    *)
  12. completedAt : Values_0.DateType.t option;
    (*

    The timestamp, when the command execution was completed.

    *)
  13. timeToLive : Values_0.DateType.t option;
    (*

    The time to live (TTL) parameter that indicates the duration for which executions will be retained in your account. The default value is six months.

    *)
}
Sourcetype nonrec error = [
  1. | `InternalServerException of Values_0.InternalServerException.t
  2. | `ResourceNotFoundException of Values_0.ResourceNotFoundException.t
  3. | `ThrottlingException of Values_0.ThrottlingException.t
  4. | `ValidationException of Values_0.ValidationException.t
  5. | `Unknown_operation_error of string * string option
]
Sourceval make : ?executionId:??? -> ?commandArn:??? -> ?targetArn:??? -> ?status:??? -> ?statusReason:??? -> ?result:??? -> ?parameters:??? -> ?executionTimeoutSeconds:??? -> ?createdAt:??? -> ?lastUpdatedAt:??? -> ?startedAt:??? -> ?completedAt:??? -> ?timeToLive:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InternalServerException of Values_0.InternalServerException.t | `ResourceNotFoundException of Values_0.ResourceNotFoundException.t | `ThrottlingException of Values_0.ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of Values_0.ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InternalServerException of Values_0.InternalServerException.t | `ResourceNotFoundException of Values_0.ResourceNotFoundException.t | `ThrottlingException of Values_0.ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of Values_0.ValidationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Long of Values_0.CommandExecutionTimeoutInSeconds.t | `Map of ([> `String of string ] * [> `Structure of (string * [> `Blob of string | `Boolean of bool | `Double of float | `Integer of int | `Long of Awso.Import.Int64.t | `String of string ]) list ]) list | `String of Values_0.CommandExecutionId.t | `Structure of (string * [> `String of string ]) list | `Timestamp of Values_0.DateType.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t