Amazonka.CodePipeline.PutWebhook

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.

Creating a Request

data PutWebhook

See: newPutWebhook smart constructor.

Constructors

PutWebhook'

Fields

• tags :: Maybe [Tag]

  The tags for the webhook.

• webhook :: 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 that helps you identify it. You might name the webhook after the pipeline and action it targets so that you can easily recognize what it's used for later.

Instances

ToJSON PutWebhook

Defined in Amazonka.CodePipeline.PutWebhook

Methods

toJSON :: PutWebhook -> Value

toEncoding :: PutWebhook -> Encoding

toJSONList :: [PutWebhook] -> Value

toEncodingList :: [PutWebhook] -> Encoding

ToHeaders PutWebhook

Defined in Amazonka.CodePipeline.PutWebhook

Methods

toHeaders :: PutWebhook -> [Header]

ToPath PutWebhook

Defined in Amazonka.CodePipeline.PutWebhook

Methods

toPath :: PutWebhook -> ByteString

ToQuery PutWebhook

Defined in Amazonka.CodePipeline.PutWebhook

Methods

toQuery :: PutWebhook -> QueryString

AWSRequest PutWebhook

Defined in Amazonka.CodePipeline.PutWebhook

Associated Types

type AWSResponse PutWebhook

Methods

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

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

Generic PutWebhook

Defined in Amazonka.CodePipeline.PutWebhook

Associated Types

type Rep PutWebhook :: Type -> Type

Methods

from :: PutWebhook -> Rep PutWebhook x

to :: Rep PutWebhook x -> PutWebhook

Read PutWebhook

Defined in Amazonka.CodePipeline.PutWebhook

Methods

readsPrec :: Int -> ReadS PutWebhook

readList :: ReadS [PutWebhook]

readPrec :: ReadPrec PutWebhook

readListPrec :: ReadPrec [PutWebhook]

Show PutWebhook

Defined in Amazonka.CodePipeline.PutWebhook

Methods

showsPrec :: Int -> PutWebhook -> ShowS

show :: PutWebhook -> String

showList :: [PutWebhook] -> ShowS

NFData PutWebhook

Defined in Amazonka.CodePipeline.PutWebhook

Methods

rnf :: PutWebhook -> ()

Eq PutWebhook

Defined in Amazonka.CodePipeline.PutWebhook

Methods

(==) :: PutWebhook -> PutWebhook -> Bool

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

Hashable PutWebhook

Defined in Amazonka.CodePipeline.PutWebhook

Methods

hashWithSalt :: Int -> PutWebhook -> Int

hash :: PutWebhook -> Int

type AWSResponse PutWebhook

Defined in Amazonka.CodePipeline.PutWebhook

type AWSResponse PutWebhook = PutWebhookResponse

type Rep PutWebhook

Defined in Amazonka.CodePipeline.PutWebhook

type Rep PutWebhook = D1 ('MetaData "PutWebhook" "Amazonka.CodePipeline.PutWebhook" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "PutWebhook'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "webhook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WebhookDefinition)))

newPutWebhook

Arguments

:: WebhookDefinition

PutWebhook

-> PutWebhook

Create a value of PutWebhook 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:

PutWebhook, putWebhook_tags - The tags for the webhook.

PutWebhook, putWebhook_webhook - 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 that helps you identify it. You might name the webhook after the pipeline and action it targets so that you can easily recognize what it's used for later.

Request Lenses

putWebhook_tags :: Lens' PutWebhook (Maybe [Tag])

The tags for the webhook.

putWebhook_webhook :: 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 that helps you identify it. You might 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

data PutWebhookResponse

See: newPutWebhookResponse smart constructor.

Constructors

PutWebhookResponse'

Fields

• webhook :: Maybe ListWebhookItem

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic PutWebhookResponse

Defined in Amazonka.CodePipeline.PutWebhook

Associated Types

type Rep PutWebhookResponse :: Type -> Type

Methods

from :: PutWebhookResponse -> Rep PutWebhookResponse x

to :: Rep PutWebhookResponse x -> PutWebhookResponse

Read PutWebhookResponse

Defined in Amazonka.CodePipeline.PutWebhook

Methods

readsPrec :: Int -> ReadS PutWebhookResponse

readList :: ReadS [PutWebhookResponse]

readPrec :: ReadPrec PutWebhookResponse

readListPrec :: ReadPrec [PutWebhookResponse]

Show PutWebhookResponse

Defined in Amazonka.CodePipeline.PutWebhook

Methods

showsPrec :: Int -> PutWebhookResponse -> ShowS

show :: PutWebhookResponse -> String

showList :: [PutWebhookResponse] -> ShowS

NFData PutWebhookResponse

Defined in Amazonka.CodePipeline.PutWebhook

Methods

rnf :: PutWebhookResponse -> ()

Eq PutWebhookResponse

Defined in Amazonka.CodePipeline.PutWebhook

Methods

(==) :: PutWebhookResponse -> PutWebhookResponse -> Bool

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

type Rep PutWebhookResponse

Defined in Amazonka.CodePipeline.PutWebhook

type Rep PutWebhookResponse = D1 ('MetaData "PutWebhookResponse" "Amazonka.CodePipeline.PutWebhook" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "PutWebhookResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "webhook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ListWebhookItem)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutWebhookResponse

Arguments

:: Int

$sel:httpStatus:PutWebhookResponse'

-> PutWebhookResponse

Create a value of PutWebhookResponse 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:

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

$sel:httpStatus:PutWebhookResponse', putWebhookResponse_httpStatus - The response's http status code.

Response Lenses

putWebhookResponse_webhook :: Lens' PutWebhookResponse (Maybe ListWebhookItem)

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

putWebhookResponse_httpStatus :: Lens' PutWebhookResponse Int

The response's http status code.