Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Amplify.StartJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data StartJob = StartJob' {
- commitId :: Maybe Text
- jobId :: Maybe Text
- jobReason :: Maybe Text
- commitTime :: Maybe POSIX
- commitMessage :: Maybe Text
- appId :: Text
- branchName :: Text
- jobType :: JobType
}
newStartJob :: Text -> Text -> JobType -> StartJob
startJob_commitId :: Lens' StartJob (Maybe Text)
startJob_jobId :: Lens' StartJob (Maybe Text)
startJob_jobReason :: Lens' StartJob (Maybe Text)
startJob_commitTime :: Lens' StartJob (Maybe UTCTime)
startJob_commitMessage :: Lens' StartJob (Maybe Text)
startJob_appId :: Lens' StartJob Text
startJob_branchName :: Lens' StartJob Text
startJob_jobType :: Lens' StartJob JobType
data StartJobResponse = StartJobResponse' {
- httpStatus :: Int
- jobSummary :: JobSummary
}
newStartJobResponse :: Int -> JobSummary -> StartJobResponse
startJobResponse_httpStatus :: Lens' StartJobResponse Int
startJobResponse_jobSummary :: Lens' StartJobResponse JobSummary

Creating a Request

data StartJob Source #

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.
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.
commitTime :: Maybe POSIX
The commit date and time for the job.
commitMessage :: Maybe Text
The commit message from a third-party repository provider for the 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

Instances details

Eq StartJob Source #
Instance details Defined in Amazonka.Amplify.StartJob Methods (==) :: StartJob -> StartJob -> Bool # (/=) :: StartJob -> StartJob -> Bool #
Read StartJob Source #
Instance details Defined in Amazonka.Amplify.StartJob Methods readsPrec :: Int -> ReadS StartJob # readList :: ReadS [StartJob] # readPrec :: ReadPrec StartJob # readListPrec :: ReadPrec [StartJob] #
Show StartJob Source #
Instance details Defined in Amazonka.Amplify.StartJob Methods showsPrec :: Int -> StartJob -> ShowS # show :: StartJob -> String # showList :: [StartJob] -> ShowS #
Generic StartJob Source #
Instance details Defined in Amazonka.Amplify.StartJob Associated Types type Rep StartJob :: Type -> Type # Methods from :: StartJob -> Rep StartJob x # to :: Rep StartJob x -> StartJob #
NFData StartJob Source #
Instance details Defined in Amazonka.Amplify.StartJob Methods rnf :: StartJob -> () #
Hashable StartJob Source #
Instance details Defined in Amazonka.Amplify.StartJob Methods hashWithSalt :: Int -> StartJob -> Int # hash :: StartJob -> Int #
ToJSON StartJob Source #
Instance details Defined in Amazonka.Amplify.StartJob Methods toJSON :: StartJob -> Value # toEncoding :: StartJob -> Encoding # toJSONList :: [StartJob] -> Value # toEncodingList :: [StartJob] -> Encoding #
AWSRequest StartJob Source #
Instance details Defined in Amazonka.Amplify.StartJob Associated Types type AWSResponse StartJob # Methods request :: StartJob -> Request StartJob # response :: MonadResource m => Logger -> Service -> Proxy StartJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartJob))) #
ToHeaders StartJob Source #
Instance details Defined in Amazonka.Amplify.StartJob Methods toHeaders :: StartJob -> [Header] #
ToPath StartJob Source #
Instance details Defined in Amazonka.Amplify.StartJob Methods toPath :: StartJob -> ByteString #
ToQuery StartJob Source #
Instance details Defined in Amazonka.Amplify.StartJob Methods toQuery :: StartJob -> QueryString #
type Rep StartJob Source #
Instance details Defined in Amazonka.Amplify.StartJob type Rep StartJob = D1 ('MetaData "StartJob" "Amazonka.Amplify.StartJob" "libZSservicesZSamazonka-amplifyZSamazonka-amplify" 'False) (C1 ('MetaCons "StartJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "commitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "jobReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "commitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "commitMessage") '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)))))
type AWSResponse StartJob Source #
Instance details Defined in Amazonka.Amplify.StartJob type AWSResponse StartJob = StartJobResponse

newStartJob Source #

Arguments

:: Text	`$sel:appId:StartJob'`
-> Text	`$sel:branchName:StartJob'`
-> JobType	`$sel: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:

$sel:commitId:StartJob', startJob_commitId - The commit ID from a third-party repository provider for the job.

$sel:jobId: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.

$sel:commitTime:StartJob', startJob_commitTime - The commit date and time for the job.

$sel:commitMessage:StartJob', startJob_commitMessage - The commit message from a third-party repository provider for the job.

$sel:appId:StartJob', startJob_appId - The unique ID for an Amplify app.

$sel:branchName:StartJob', startJob_branchName - The branch name for the job.

$sel:jobType: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) Source #

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

startJob_jobId :: Lens' StartJob (Maybe Text) Source #

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

startJob_jobReason :: Lens' StartJob (Maybe Text) Source #

A descriptive reason for starting this job.

startJob_commitTime :: Lens' StartJob (Maybe UTCTime) Source #

The commit date and time for the job.

startJob_commitMessage :: Lens' StartJob (Maybe Text) Source #

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

startJob_appId :: Lens' StartJob Text Source #

The unique ID for an Amplify app.

startJob_branchName :: Lens' StartJob Text Source #

The branch name for the job.

startJob_jobType :: Lens' StartJob JobType Source #

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 Source #

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

Instances details

Eq StartJobResponse Source #
Instance details Defined in Amazonka.Amplify.StartJob Methods (==) :: StartJobResponse -> StartJobResponse -> Bool # (/=) :: StartJobResponse -> StartJobResponse -> Bool #
Read StartJobResponse Source #
Instance details Defined in Amazonka.Amplify.StartJob Methods readsPrec :: Int -> ReadS StartJobResponse # readList :: ReadS [StartJobResponse] # readPrec :: ReadPrec StartJobResponse # readListPrec :: ReadPrec [StartJobResponse] #
Show StartJobResponse Source #
Instance details Defined in Amazonka.Amplify.StartJob Methods showsPrec :: Int -> StartJobResponse -> ShowS # show :: StartJobResponse -> String # showList :: [StartJobResponse] -> ShowS #
Generic StartJobResponse Source #
Instance details Defined in Amazonka.Amplify.StartJob Associated Types type Rep StartJobResponse :: Type -> Type # Methods from :: StartJobResponse -> Rep StartJobResponse x # to :: Rep StartJobResponse x -> StartJobResponse #
NFData StartJobResponse Source #
Instance details Defined in Amazonka.Amplify.StartJob Methods rnf :: StartJobResponse -> () #
type Rep StartJobResponse Source #
Instance details Defined in Amazonka.Amplify.StartJob type Rep StartJobResponse = D1 ('MetaData "StartJobResponse" "Amazonka.Amplify.StartJob" "libZSservicesZSamazonka-amplifyZSamazonka-amplify" '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 Source #

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 Source #

The response's http status code.

startJobResponse_jobSummary :: Lens' StartJobResponse JobSummary Source #

The summary for the job.