Module Values.StartJobRequestSource

The request structure for the start job request.

Sourcetype nonrec t = {
  1. appId : AppId.t;
    (*

    The unique ID for an Amplify app.

    *)
  2. branchName : BranchName.t;
    (*

    The name of the branch to use for the job.

    *)
  3. jobId : JobId.t option;
    (*

    The unique ID for an existing job. This is required if the value of jobType is RETRY.

    *)
  4. jobType : JobType.t;
    (*

    Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository. The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.

    *)
  5. jobReason : JobReason.t option;
    (*

    A descriptive reason for starting the job.

    *)
  6. commitId : CommitId.t option;
    (*

    The commit ID from a third-party repository provider for the job.

    *)
  7. commitMessage : CommitMessage.t option;
    (*

    The commit message from a third-party repository provider for the job.

    *)
  8. commitTime : CommitTime.t option;
    (*

    The commit date and time for the job.

    *)
}
Sourceval context_ : string
Sourceval make : ?jobId:??? -> ?jobReason:??? -> ?commitId:??? -> ?commitMessage:??? -> ?commitTime:??? -> appId:AppId.t -> branchName:BranchName.t -> jobType:JobType.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of AppId.t | `Timestamp of CommitTime.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