Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.CodePipeline.PutWebhook

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.

Synopsis

Creating a Request

putWebhook #

Arguments

:: WebhookDefinition	`pwWebhook`
-> PutWebhook

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

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

pwWebhook - The detail provided in an input file to create the webhook, such as the webhook name, the pipeline name, and the action name. Give the webhook a unique name which identifies the webhook being defined. You may choose to name the webhook after the pipeline and action it targets so that you can easily recognize what it's used for later.

data PutWebhook #

See: putWebhook smart constructor.

Instances

Eq PutWebhook #
Methods (==) :: PutWebhook -> PutWebhook -> Bool # (/=) :: PutWebhook -> PutWebhook -> Bool #
Data PutWebhook #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutWebhook -> c PutWebhook # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutWebhook # toConstr :: PutWebhook -> Constr # dataTypeOf :: PutWebhook -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c PutWebhook) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutWebhook) # gmapT :: (forall b. Data b => b -> b) -> PutWebhook -> PutWebhook # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutWebhook -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutWebhook -> r # gmapQ :: (forall d. Data d => d -> u) -> PutWebhook -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PutWebhook -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutWebhook -> m PutWebhook # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutWebhook -> m PutWebhook # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutWebhook -> m PutWebhook #
Read PutWebhook #
Methods readsPrec :: Int -> ReadS PutWebhook # readList :: ReadS [PutWebhook] # readPrec :: ReadPrec PutWebhook # readListPrec :: ReadPrec [PutWebhook] #
Show PutWebhook #
Methods showsPrec :: Int -> PutWebhook -> ShowS # show :: PutWebhook -> String # showList :: [PutWebhook] -> ShowS #
Generic PutWebhook #
Associated Types type Rep PutWebhook :: * -> * # Methods from :: PutWebhook -> Rep PutWebhook x # to :: Rep PutWebhook x -> PutWebhook #
Hashable PutWebhook #
Methods hashWithSalt :: Int -> PutWebhook -> Int # hash :: PutWebhook -> Int #
ToJSON PutWebhook #
Methods toJSON :: PutWebhook -> Value # toEncoding :: PutWebhook -> Encoding # toJSONList :: [PutWebhook] -> Value # toEncodingList :: [PutWebhook] -> Encoding #
NFData PutWebhook #
Methods rnf :: PutWebhook -> () #
AWSRequest PutWebhook #
Associated Types type Rs PutWebhook :: * # Methods request :: PutWebhook -> Request PutWebhook # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * PutWebhook -> ClientResponse -> m (Response PutWebhook) #
ToHeaders PutWebhook #
Methods toHeaders :: PutWebhook -> [Header] #
ToPath PutWebhook #
Methods toPath :: PutWebhook -> ByteString #
ToQuery PutWebhook #
Methods toQuery :: PutWebhook -> QueryString #
type Rep PutWebhook #
type Rep PutWebhook = D1 * (MetaData "PutWebhook" "Network.AWS.CodePipeline.PutWebhook" "amazonka-codepipeline-1.6.0-GX4ZtkGvrnsLYRyLBFiLdF" True) (C1 * (MetaCons "PutWebhook'" PrefixI True) (S1 * (MetaSel (Just Symbol "_pwWebhook") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * WebhookDefinition)))
type Rs PutWebhook #
type Rs PutWebhook = PutWebhookResponse

Request Lenses

pwWebhook :: Lens' PutWebhook WebhookDefinition #

The detail provided in an input file to create the webhook, such as the webhook name, the pipeline name, and the action name. Give the webhook a unique name which identifies the webhook being defined. You may choose to name the webhook after the pipeline and action it targets so that you can easily recognize what it's used for later.

Destructuring the Response

putWebhookResponse #

Arguments

:: Int	`pwrsResponseStatus`
-> PutWebhookResponse

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

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

pwrsWebhook - The detail returned from creating the webhook, such as the webhook name, webhook URL, and webhook ARN.
pwrsResponseStatus - -- | The response status code.

data PutWebhookResponse #

See: putWebhookResponse smart constructor.

Instances

Eq PutWebhookResponse #
Methods (==) :: PutWebhookResponse -> PutWebhookResponse -> Bool # (/=) :: PutWebhookResponse -> PutWebhookResponse -> Bool #
Data PutWebhookResponse #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutWebhookResponse -> c PutWebhookResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutWebhookResponse # toConstr :: PutWebhookResponse -> Constr # dataTypeOf :: PutWebhookResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c PutWebhookResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutWebhookResponse) # gmapT :: (forall b. Data b => b -> b) -> PutWebhookResponse -> PutWebhookResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutWebhookResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutWebhookResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> PutWebhookResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PutWebhookResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutWebhookResponse -> m PutWebhookResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutWebhookResponse -> m PutWebhookResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutWebhookResponse -> m PutWebhookResponse #
Read PutWebhookResponse #
Methods readsPrec :: Int -> ReadS PutWebhookResponse # readList :: ReadS [PutWebhookResponse] # readPrec :: ReadPrec PutWebhookResponse # readListPrec :: ReadPrec [PutWebhookResponse] #
Show PutWebhookResponse #
Methods showsPrec :: Int -> PutWebhookResponse -> ShowS # show :: PutWebhookResponse -> String # showList :: [PutWebhookResponse] -> ShowS #
Generic PutWebhookResponse #
Associated Types type Rep PutWebhookResponse :: * -> * # Methods from :: PutWebhookResponse -> Rep PutWebhookResponse x # to :: Rep PutWebhookResponse x -> PutWebhookResponse #
NFData PutWebhookResponse #
Methods rnf :: PutWebhookResponse -> () #
type Rep PutWebhookResponse #
type Rep PutWebhookResponse = D1 * (MetaData "PutWebhookResponse" "Network.AWS.CodePipeline.PutWebhook" "amazonka-codepipeline-1.6.0-GX4ZtkGvrnsLYRyLBFiLdF" False) (C1 * (MetaCons "PutWebhookResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_pwrsWebhook") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ListWebhookItem))) (S1 * (MetaSel (Just Symbol "_pwrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

pwrsWebhook :: Lens' PutWebhookResponse (Maybe ListWebhookItem) #

The detail returned from creating the webhook, such as the webhook name, webhook URL, and webhook ARN.

pwrsResponseStatus :: Lens' PutWebhookResponse Int #

- | The response status code.