Amazonka.Amplify.StartJob

Starts a new job for a branch of an Amplify app.

Creating a Request

data StartJob

The request structure for the start job request.

See: newStartJob smart constructor.

Constructors

StartJob'

Fields

• commitId :: Maybe Text

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

• commitMessage :: Maybe Text

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

• commitTime :: Maybe POSIX

  The commit date and time for the job.

• jobId :: Maybe Text

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

• jobReason :: Maybe Text

  A descriptive reason for starting this job.

• appId :: Text

  The unique ID for an Amplify app.

• branchName :: Text

  The branch name for the job.

• jobType :: 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.

Instances

ToJSON StartJob

Defined in Amazonka.Amplify.StartJob

Methods

toJSON :: StartJob -> Value

toEncoding :: StartJob -> Encoding

toJSONList :: [StartJob] -> Value

toEncodingList :: [StartJob] -> Encoding

ToHeaders StartJob

Defined in Amazonka.Amplify.StartJob

Methods

toHeaders :: StartJob -> [Header]

ToPath StartJob

Defined in Amazonka.Amplify.StartJob

Methods

toPath :: StartJob -> ByteString

ToQuery StartJob

Defined in Amazonka.Amplify.StartJob

Methods

toQuery :: StartJob -> QueryString

AWSRequest StartJob

Defined in Amazonka.Amplify.StartJob

Associated Types

type AWSResponse StartJob

Methods

request :: (Service -> Service) -> StartJob -> Request StartJob

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartJob)))

Generic StartJob

Defined in Amazonka.Amplify.StartJob

Associated Types

type Rep StartJob :: Type -> Type

Methods

from :: StartJob -> Rep StartJob x

to :: Rep StartJob x -> StartJob

Read StartJob

Defined in Amazonka.Amplify.StartJob

Methods

readsPrec :: Int -> ReadS StartJob

readList :: ReadS [StartJob]

readPrec :: ReadPrec StartJob

readListPrec :: ReadPrec [StartJob]

Show StartJob

Defined in Amazonka.Amplify.StartJob

Methods

showsPrec :: Int -> StartJob -> ShowS

show :: StartJob -> String

showList :: [StartJob] -> ShowS

NFData StartJob

Defined in Amazonka.Amplify.StartJob

Methods

rnf :: StartJob -> ()

Eq StartJob

Defined in Amazonka.Amplify.StartJob

Methods

(==) :: StartJob -> StartJob -> Bool

(/=) :: StartJob -> StartJob -> Bool

Hashable StartJob

Defined in Amazonka.Amplify.StartJob

Methods

hashWithSalt :: Int -> StartJob -> Int

hash :: StartJob -> Int

type AWSResponse StartJob

Defined in Amazonka.Amplify.StartJob

type AWSResponse StartJob = StartJobResponse

type Rep StartJob

Defined in Amazonka.Amplify.StartJob

type Rep StartJob = D1 ('MetaData "StartJob" "Amazonka.Amplify.StartJob" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "StartJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "commitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "commitMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "commitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "jobReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "branchName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "jobType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobType)))))

newStartJob

Arguments

:: Text

StartJob

-> Text

StartJob

-> JobType

StartJob

-> StartJob

Create a value of StartJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

StartJob, startJob_commitTime - The commit date and time for the job.

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

$sel:jobReason:StartJob', startJob_jobReason - A descriptive reason for starting this job.

StartJob, startJob_appId - The unique ID for an Amplify app.

StartJob, startJob_branchName - The branch name for the job.

StartJob, startJob_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.

Request Lenses

startJob_commitId :: Lens' StartJob (Maybe Text)

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

startJob_commitMessage :: Lens' StartJob (Maybe Text)

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

startJob_commitTime :: Lens' StartJob (Maybe UTCTime)

The commit date and time for the job.

startJob_jobId :: Lens' StartJob (Maybe Text)

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

startJob_jobReason :: Lens' StartJob (Maybe Text)

A descriptive reason for starting this job.

startJob_appId :: Lens' StartJob Text

The unique ID for an Amplify app.

startJob_branchName :: Lens' StartJob Text

The branch name for the job.

startJob_jobType :: Lens' StartJob 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.

Destructuring the Response

data StartJobResponse

The result structure for the run job request.

See: newStartJobResponse smart constructor.

Constructors

StartJobResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• jobSummary :: JobSummary

  The summary for the job.

Instances

Generic StartJobResponse

Defined in Amazonka.Amplify.StartJob

Associated Types

type Rep StartJobResponse :: Type -> Type

Methods

from :: StartJobResponse -> Rep StartJobResponse x

to :: Rep StartJobResponse x -> StartJobResponse

Read StartJobResponse

Defined in Amazonka.Amplify.StartJob

Methods

readsPrec :: Int -> ReadS StartJobResponse

readList :: ReadS [StartJobResponse]

readPrec :: ReadPrec StartJobResponse

readListPrec :: ReadPrec [StartJobResponse]

Show StartJobResponse

Defined in Amazonka.Amplify.StartJob

Methods

showsPrec :: Int -> StartJobResponse -> ShowS

show :: StartJobResponse -> String

showList :: [StartJobResponse] -> ShowS

NFData StartJobResponse

Defined in Amazonka.Amplify.StartJob

Methods

rnf :: StartJobResponse -> ()

Eq StartJobResponse

Defined in Amazonka.Amplify.StartJob

Methods

(==) :: StartJobResponse -> StartJobResponse -> Bool

(/=) :: StartJobResponse -> StartJobResponse -> Bool

type Rep StartJobResponse

Defined in Amazonka.Amplify.StartJob

type Rep StartJobResponse = D1 ('MetaData "StartJobResponse" "Amazonka.Amplify.StartJob" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "StartJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "jobSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobSummary)))

newStartJobResponse

Arguments

:: Int

$sel:httpStatus:StartJobResponse'

-> JobSummary

$sel:jobSummary:StartJobResponse'

-> StartJobResponse

Create a value of StartJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:StartJobResponse', startJobResponse_httpStatus - The response's http status code.

$sel:jobSummary:StartJobResponse', startJobResponse_jobSummary - The summary for the job.

Response Lenses

startJobResponse_httpStatus :: Lens' StartJobResponse Int

The response's http status code.

startJobResponse_jobSummary :: Lens' StartJobResponse JobSummary

The summary for the job.