Network.AWS.CodeBuild.StartBuild

Starts running a build.

Creating a Request

startBuild

Arguments

:: Text

sbProjectName

-> StartBuild

Creates a value of StartBuild with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sbEnvironmentVariablesOverride - A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
• sbTimeoutInMinutesOverride - The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.
• sbSourceVersion - A version of the build input to be built, for this build only. If not specified, the latest version will be used. If specified, must be one of: * For AWS CodeCommit: the commit ID to use. * For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25 ). If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used. * For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used. * For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing the build input ZIP file to use.
• sbBuildspecOverride - A build spec declaration that overrides, for this build only, the latest one already defined in the build project.
• sbArtifactsOverride - Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
• sbProjectName - The name of the build project to start running a build.

data StartBuild

See: startBuild smart constructor.

Instances

Eq StartBuild

Methods

(==) :: StartBuild -> StartBuild -> Bool

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

Data StartBuild

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartBuild -> c StartBuild

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartBuild

toConstr :: StartBuild -> Constr

dataTypeOf :: StartBuild -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StartBuild)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartBuild)

gmapT :: (forall b. Data b => b -> b) -> StartBuild -> StartBuild

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartBuild -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartBuild -> r

gmapQ :: (forall d. Data d => d -> u) -> StartBuild -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> StartBuild -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartBuild -> m StartBuild

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartBuild -> m StartBuild

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartBuild -> m StartBuild

Read StartBuild

Methods

readsPrec :: Int -> ReadS StartBuild

readList :: ReadS [StartBuild]

readPrec :: ReadPrec StartBuild

readListPrec :: ReadPrec [StartBuild]

Show StartBuild

Methods

showsPrec :: Int -> StartBuild -> ShowS

show :: StartBuild -> String

showList :: [StartBuild] -> ShowS

Generic StartBuild

Associated Types

type Rep StartBuild :: * -> *

Methods

from :: StartBuild -> Rep StartBuild x

to :: Rep StartBuild x -> StartBuild

Hashable StartBuild

Methods

hashWithSalt :: Int -> StartBuild -> Int

hash :: StartBuild -> Int

ToJSON StartBuild

Methods

toJSON :: StartBuild -> Value

toEncoding :: StartBuild -> Encoding

toJSONList :: [StartBuild] -> Value

toEncodingList :: [StartBuild] -> Encoding

NFData StartBuild

Methods

rnf :: StartBuild -> ()

AWSRequest StartBuild

Associated Types

type Rs StartBuild :: *

Methods

request :: StartBuild -> Request StartBuild

response :: MonadResource m => Logger -> Service -> Proxy * StartBuild -> ClientResponse -> m (Response StartBuild)

ToQuery StartBuild

Methods

toQuery :: StartBuild -> QueryString

ToPath StartBuild

Methods

toPath :: StartBuild -> ByteString

ToHeaders StartBuild

Methods

toHeaders :: StartBuild -> [Header]

type Rep StartBuild

type Rep StartBuild = D1 (MetaData "StartBuild" "Network.AWS.CodeBuild.StartBuild" "amazonka-codebuild-1.5.0-2ek6cqv6qBXE0cPl3ApURV" False) (C1 (MetaCons "StartBuild'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sbEnvironmentVariablesOverride") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [EnvironmentVariable]))) ((:*:) (S1 (MetaSel (Just Symbol "_sbTimeoutInMinutesOverride") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_sbSourceVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_sbBuildspecOverride") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_sbArtifactsOverride") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ProjectArtifacts))) (S1 (MetaSel (Just Symbol "_sbProjectName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs StartBuild

type Rs StartBuild = StartBuildResponse

Request Lenses

sbEnvironmentVariablesOverride :: Lens' StartBuild [EnvironmentVariable]

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

sbTimeoutInMinutesOverride :: Lens' StartBuild (Maybe Natural)

The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.

sbSourceVersion :: Lens' StartBuild (Maybe Text)

A version of the build input to be built, for this build only. If not specified, the latest version will be used. If specified, must be one of: * For AWS CodeCommit: the commit ID to use. * For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25 ). If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used. * For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used. * For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing the build input ZIP file to use.

sbBuildspecOverride :: Lens' StartBuild (Maybe Text)

A build spec declaration that overrides, for this build only, the latest one already defined in the build project.

sbArtifactsOverride :: Lens' StartBuild (Maybe ProjectArtifacts)

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

sbProjectName :: Lens' StartBuild Text

The name of the build project to start running a build.

Destructuring the Response

startBuildResponse

Arguments

:: Int

srsResponseStatus

-> StartBuildResponse

Creates a value of StartBuildResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• srsBuild - Information about the build to be run.
• srsResponseStatus - -- | The response status code.

data StartBuildResponse

See: startBuildResponse smart constructor.

Instances

Eq StartBuildResponse

Methods

(==) :: StartBuildResponse -> StartBuildResponse -> Bool

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

Data StartBuildResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartBuildResponse -> c StartBuildResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartBuildResponse

toConstr :: StartBuildResponse -> Constr

dataTypeOf :: StartBuildResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StartBuildResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartBuildResponse)

gmapT :: (forall b. Data b => b -> b) -> StartBuildResponse -> StartBuildResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartBuildResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartBuildResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> StartBuildResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> StartBuildResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartBuildResponse -> m StartBuildResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartBuildResponse -> m StartBuildResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartBuildResponse -> m StartBuildResponse

Read StartBuildResponse

Methods

readsPrec :: Int -> ReadS StartBuildResponse

readList :: ReadS [StartBuildResponse]

readPrec :: ReadPrec StartBuildResponse

readListPrec :: ReadPrec [StartBuildResponse]

Show StartBuildResponse

Methods

showsPrec :: Int -> StartBuildResponse -> ShowS

show :: StartBuildResponse -> String

showList :: [StartBuildResponse] -> ShowS

Generic StartBuildResponse

Associated Types

type Rep StartBuildResponse :: * -> *

Methods

from :: StartBuildResponse -> Rep StartBuildResponse x

to :: Rep StartBuildResponse x -> StartBuildResponse

NFData StartBuildResponse

Methods

rnf :: StartBuildResponse -> ()

type Rep StartBuildResponse

type Rep StartBuildResponse = D1 (MetaData "StartBuildResponse" "Network.AWS.CodeBuild.StartBuild" "amazonka-codebuild-1.5.0-2ek6cqv6qBXE0cPl3ApURV" False) (C1 (MetaCons "StartBuildResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_srsBuild") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Build))) (S1 (MetaSel (Just Symbol "_srsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

srsBuild :: Lens' StartBuildResponse (Maybe Build)

Information about the build to be run.

srsResponseStatus :: Lens' StartBuildResponse Int

• - | The response status code.