AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the StartJob operation. Starts a new job for a branch of an Amplify app.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Amplify.AmazonAmplifyRequest
      Amazon.Amplify.Model.StartJobRequest

Namespace: Amazon.Amplify.Model
Assembly: AWSSDK.Amplify.dll
Version: 3.x.y.z

Syntax

C# 
public class StartJobRequest : AmazonAmplifyRequest
         IAmazonWebServiceRequest

The StartJobRequest type exposes the following members

Constructors

NameDescription
Public Method StartJobRequest()

Properties

NameTypeDescription
Public Property AppId System.String

Gets and sets the property AppId.

The unique ID for an Amplify app.

Public Property BranchName System.String

Gets and sets the property BranchName.

The name of the branch to use for the job.

Public Property CommitId System.String

Gets and sets the property CommitId.

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

Public Property CommitMessage System.String

Gets and sets the property CommitMessage.

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

Public Property CommitTime System.DateTime

Gets and sets the property CommitTime.

The commit date and time for the job.

Public Property JobId System.String

Gets and sets the property JobId.

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

Public Property JobReason System.String

Gets and sets the property JobReason.

A descriptive reason for starting the job.

Public Property JobType Amazon.Amplify.JobType

Gets and sets the property JobType.

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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5