| 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.CodePipeline.PutWebhook
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
- data PutWebhook = PutWebhook' {
- tags :: Maybe [Tag]
- webhook :: WebhookDefinition
- newPutWebhook :: WebhookDefinition -> PutWebhook
- putWebhook_tags :: Lens' PutWebhook (Maybe [Tag])
- putWebhook_webhook :: Lens' PutWebhook WebhookDefinition
- data PutWebhookResponse = PutWebhookResponse' {}
- newPutWebhookResponse :: Int -> PutWebhookResponse
- putWebhookResponse_webhook :: Lens' PutWebhookResponse (Maybe ListWebhookItem)
- putWebhookResponse_httpStatus :: Lens' PutWebhookResponse Int
Creating a Request
data PutWebhook Source #
See: newPutWebhook smart constructor.
Constructors
| PutWebhook' | |
Fields
| |
Instances
Arguments
| :: WebhookDefinition | |
| -> 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:
$sel:tags:PutWebhook', putWebhook_tags - The tags for the webhook.
$sel: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]) Source #
The tags for the webhook.
putWebhook_webhook :: Lens' PutWebhook WebhookDefinition Source #
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 Source #
See: newPutWebhookResponse smart constructor.
Constructors
| PutWebhookResponse' | |
Fields
| |
Instances
newPutWebhookResponse Source #
Arguments
| :: Int | |
| -> 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:
$sel:webhook: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) Source #
The detail returned from creating the webhook, such as the webhook name, webhook URL, and webhook ARN.
putWebhookResponse_httpStatus :: Lens' PutWebhookResponse Int Source #
The response's http status code.