Module Values.GetDeploymentResponseSource

Gets a deployment. Deployments define the components that run on Greengrass core devices.

Sourcetype nonrec t = {
  1. targetArn : TargetARN.t option;
    (*

    The ARN of the target IoT thing or thing group.

    *)
  2. revisionId : NonEmptyString.t option;
    (*

    The revision number of the deployment.

    *)
  3. deploymentId : NonEmptyString.t option;
    (*

    The ID of the deployment.

    *)
  4. deploymentName : NullableString.t option;
    (*

    The name of the deployment.

    *)
  5. deploymentStatus : DeploymentStatus.t option;
    (*

    The status of the deployment.

    *)
  6. iotJobId : NullableString.t option;
    (*

    The ID of the IoT job that applies the deployment to target devices.

    *)
  7. iotJobArn : IoTJobARN.t option;
    (*

    The ARN of the IoT job that applies the deployment to target devices.

    *)
  8. components : ComponentDeploymentSpecifications.t option;
    (*

    The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.

    *)
  9. deploymentPolicies : DeploymentPolicies.t option;
    (*

    The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.

    *)
  10. iotJobConfiguration : DeploymentIoTJobConfiguration.t option;
    (*

    The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

    *)
  11. creationTimestamp : Timestamp.t option;
    (*

    The time at which the deployment was created, expressed in ISO 8601 format.

    *)
  12. isLatestForTarget : IsLatestForTarget.t option;
    (*

    Whether or not the deployment is the latest revision for its target.

    *)
  13. parentTargetArn : ThingGroupARN.t option;
    (*

    The parent deployment's target ARN within a subdeployment.

    *)
  14. tags : TagMap.t option;
    (*

    A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `InternalServerException of InternalServerException.t
  3. | `ResourceNotFoundException of ResourceNotFoundException.t
  4. | `ThrottlingException of ThrottlingException.t
  5. | `ValidationException of ValidationException.t
  6. | `Unknown_operation_error of string * string option
]
Sourceval make : ?targetArn:??? -> ?revisionId:??? -> ?deploymentId:??? -> ?deploymentName:??? -> ?deploymentStatus:??? -> ?iotJobId:??? -> ?iotJobArn:??? -> ?components:??? -> ?deploymentPolicies:??? -> ?iotJobConfiguration:??? -> ?creationTimestamp:??? -> ?isLatestForTarget:??? -> ?parentTargetArn:??? -> ?tags:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of IsLatestForTarget.t | `Enum of string | `Map of ([> `String of NonEmptyString.t ] * [> `String of TagValue.t | `Structure of (string * [> `String of ComponentVersionString.t | `Structure of (string * [> `List of [> `String of ComponentConfigurationPath.t ] list | `String of ComponentConfigurationString.t | `Structure of (string * [> `Double of CPU.t | `Long of Memory.t ]) list ]) list ]) list ]) list | `String of TargetARN.t | `Structure of (string * [> `Enum of string | `Structure of (string * [> `Enum of string | `Integer of OptionalInteger.t | `List of [> `Structure of (string * [> `Double of IoTJobAbortThresholdPercentage.t | `Enum of string | `Integer of IoTJobMinimumNumberOfExecutedThings.t ]) list ] list | `Long of IoTJobInProgressTimeoutInMinutes.t | `Structure of (string * [> `Double of IoTJobRolloutIncrementFactor.t | `Integer of IoTJobRolloutBaseRatePerMinute.t | `Structure of (string * [> `Integer of IoTJobNumberOfThings.t ]) list ]) list ]) list ]) list | `Timestamp of Timestamp.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