Module Values_1.CreateCommandRequestSource

Creates a command. A command contains reusable configurations that can be applied before they are sent to the devices.

Sourcetype nonrec t = {
  1. commandId : Values_0.CommandId.t;
    (*

    A unique identifier for the command. We recommend using UUID. Alpha-numeric characters, hyphens, and underscores are valid for use here.

    *)
  2. namespace : Values_0.CommandNamespace.t option;
    (*

    The namespace of the command. The MQTT reserved topics and validations will be used for command executions according to the namespace setting.

    *)
  3. displayName : Values_0.DisplayName.t option;
    (*

    The user-friendly name in the console for the command. This name doesn't have to be unique. You can update the user-friendly name after you define it.

    *)
  4. description : Values_0.CommandDescription.t option;
    (*

    A short text decription of the command.

    *)
  5. payload : Values_0.CommandPayload.t option;
    (*

    The payload object for the static command. You can upload a static payload file from your local storage that contains the instructions for the device to process. The payload file can use any format. To make sure that the device correctly interprets the payload, we recommend you to specify the payload content type.

    *)
  6. payloadTemplate : Values_0.CommandPayloadTemplateString.t option;
    (*

    The payload template for the dynamic command. This parameter is required for dynamic commands where the command execution placeholders are supplied either from mandatoryParameters or when StartCommandExecution is invoked.

    *)
  7. preprocessor : Values_0.CommandPreprocessor.t option;
    (*

    Configuration that determines how payloadTemplate is processed to generate command execution payload. This parameter is required for dynamic commands, along with payloadTemplate, and mandatoryParameters.

    *)
  8. mandatoryParameters : Values_0.CommandParameterList.t option;
    (*

    A list of parameters that are used by StartCommandExecution API for execution payload generation.

    *)
  9. roleArn : Values_0.RoleArn.t option;
    (*

    The IAM role that you must provide when using the AWS-IoT-FleetWise namespace. The role grants IoT Device Management the permission to access IoT FleetWise resources for generating the payload for the command. This field is not supported when you use the AWS-IoT namespace.

    *)
  10. tags : Values_0.TagList.t option;
    (*

    Name-value pairs that are used as metadata to manage a command.

    *)
}
Sourceval context_ : string
Sourceval make : ?namespace:??? -> ?displayName:??? -> ?description:??? -> ?payload:??? -> ?payloadTemplate:??? -> ?preprocessor:??? -> ?mandatoryParameters:??? -> ?roleArn:??? -> ?tags:??? -> commandId:Values_0.CommandId.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `Structure of (string * [> `List of [> `String of string ] list | `String of string | `Structure of (string * [> `String of string ]) list ]) list ]) list ] list | `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 ] list | `String of Values_0.CommandId.t | `Structure of (string * [> `Blob of string | `String of string | `Structure of (string * [> `Enum of string ]) list ]) list ]) 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