StartJobRequest

import type { StartJobRequest } from "https://aws-api.deno.dev/v0.4/services/amplify.ts?docs=full";

The request structure for the start job request.

interface StartJobRequest {

appId: string;

branchName: string;

commitId?: string | null;

commitMessage?: string | null;

commitTime?: Date | number | null;

jobId?: string | null;

jobReason?: string | null;

jobType: JobType;

}

§Properties

appId: string

[src]

The unique ID for an Amplify app.

branchName: string

[src]

The branch name for the job.

commitId?: string | null

[src]

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

commitMessage?: string | null

[src]

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

commitTime?: Date | number | null

[src]

The commit date and time for the job.

jobId?: string | null

[src]

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

jobReason?: string | null

[src]

A descriptive reason for starting this job.

jobType: JobType

[src]

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.