Module Values.GetBatchResponseSource

Retrieves details and current status for a specific run batch, including submission progress and run execution counts.

Sourcetype nonrec t = {
  1. id : BatchId.t option;
    (*

    The identifier portion of the run batch ARN.

    *)
  2. arn : BatchArn.t option;
    (*

    The unique ARN of the run batch.

    *)
  3. uuid : BatchUuid.t option;
    (*

    The universally unique identifier (UUID) for the run batch.

    *)
  4. name : BatchName.t option;
    (*

    The optional user-friendly name of the batch.

    *)
  5. status : BatchStatus.t option;
    (*

    The current status of the run batch. Possible values: CREATING (initial setup), PENDING (ready to submit runs), SUBMITTING (submitting runs), INPROGRESS (runs executing), STOPPING (cancellation in progress), PROCESSED (all runs completed), CANCELLED (batch cancelled), FAILED (batch failed), RUNS_DELETING (deleting runs), RUNS_DELETED (runs deleted).

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

    AWS tags associated with the run batch.

    *)
  7. totalRuns : Integer.t option;
    (*

    The total number of runs in the batch.

    *)
  8. defaultRunSetting : DefaultRunSetting.t option;
    (*

    The shared configuration applied to all runs in the batch. See DefaultRunSetting.

    *)
  9. submissionSummary : SubmissionSummary.t option;
    (*

    A summary of run submission outcomes. See SubmissionSummary.

    *)
  10. runSummary : RunSummary.t option;
    (*

    A summary of run execution states. Run execution counts are eventually consistent and may lag behind actual run states. Final counts are accurate once the batch reaches PROCESSED status. See RunSummary.

    *)
  11. creationTime : BatchTimestamp.t option;
    (*

    The timestamp when the batch was created.

    *)
  12. submittedTime : BatchTimestamp.t option;
    (*

    The timestamp when all run submissions completed.

    *)
  13. processedTime : BatchTimestamp.t option;
    (*

    The timestamp when all run executions completed.

    *)
  14. failedTime : BatchTimestamp.t option;
    (*

    The timestamp when the batch transitioned to a FAILED status.

    *)
  15. failureReason : String_.t option;
    (*

    A description of the batch failure. Present only when status is FAILED.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `InternalServerException of InternalServerException.t
  3. | `RequestTimeoutException of RequestTimeoutException.t
  4. | `ResourceNotFoundException of ResourceNotFoundException.t
  5. | `ThrottlingException of ThrottlingException.t
  6. | `ValidationException of ValidationException.t
  7. | `Unknown_operation_error of string * string option
]
Sourceval make : ?id:??? -> ?arn:??? -> ?uuid:??? -> ?name:??? -> ?status:??? -> ?tags:??? -> ?totalRuns:??? -> ?defaultRunSetting:??? -> ?submissionSummary:??? -> ?runSummary:??? -> ?creationTime:??? -> ?submittedTime:??? -> ?processedTime:??? -> ?failedTime:??? -> ?failureReason:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `RequestTimeoutException of RequestTimeoutException.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 | `RequestTimeoutException of RequestTimeoutException.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 * [> `Enum of string | `Integer of Integer.t | `Map of ([> `String of TagKey.t ] * [> `String of TagValue.t ]) list | `String of BatchId.t | `Structure of (string * [> `Enum of string | `Integer of DefaultRunSettingPriorityInteger.t | `Map of ([> `String of TagKey.t ] * [> `String of TagValue.t ]) list | `String of WorkflowId.t | `Structure of 'a list ]) list | `Timestamp of BatchTimestamp.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