Amazonka.CodeBuild.UpdateWebhook

Updates the webhook associated with an CodeBuild build project.

If you use Bitbucket for your repository, rotateSecret is ignored.

Creating a Request

data UpdateWebhook

See: newUpdateWebhook smart constructor.

Constructors

UpdateWebhook'

Fields

• branchFilter :: Maybe Text

  A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.

  It is recommended that you use filterGroups instead of branchFilter.

• buildType :: Maybe WebhookBuildType

  Specifies the type of build this webhook will trigger.

• filterGroups :: Maybe [[WebhookFilter]]

  An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a build. A filter group must contain at least one EVENT WebhookFilter.

• rotateSecret :: Maybe Bool

  A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, rotateSecret is ignored.

• projectName :: Text

  The name of the CodeBuild project.

Instances

ToJSON UpdateWebhook

Defined in Amazonka.CodeBuild.UpdateWebhook

Methods

toJSON :: UpdateWebhook -> Value

toEncoding :: UpdateWebhook -> Encoding

toJSONList :: [UpdateWebhook] -> Value

toEncodingList :: [UpdateWebhook] -> Encoding

ToHeaders UpdateWebhook

Defined in Amazonka.CodeBuild.UpdateWebhook

Methods

toHeaders :: UpdateWebhook -> [Header]

ToPath UpdateWebhook

Defined in Amazonka.CodeBuild.UpdateWebhook

Methods

toPath :: UpdateWebhook -> ByteString

ToQuery UpdateWebhook

Defined in Amazonka.CodeBuild.UpdateWebhook

Methods

toQuery :: UpdateWebhook -> QueryString

AWSRequest UpdateWebhook

Defined in Amazonka.CodeBuild.UpdateWebhook

Associated Types

type AWSResponse UpdateWebhook

Methods

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

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

Generic UpdateWebhook

Defined in Amazonka.CodeBuild.UpdateWebhook

Associated Types

type Rep UpdateWebhook :: Type -> Type

Methods

from :: UpdateWebhook -> Rep UpdateWebhook x

to :: Rep UpdateWebhook x -> UpdateWebhook

Read UpdateWebhook

Defined in Amazonka.CodeBuild.UpdateWebhook

Methods

readsPrec :: Int -> ReadS UpdateWebhook

readList :: ReadS [UpdateWebhook]

readPrec :: ReadPrec UpdateWebhook

readListPrec :: ReadPrec [UpdateWebhook]

Show UpdateWebhook

Defined in Amazonka.CodeBuild.UpdateWebhook

Methods

showsPrec :: Int -> UpdateWebhook -> ShowS

show :: UpdateWebhook -> String

showList :: [UpdateWebhook] -> ShowS

NFData UpdateWebhook

Defined in Amazonka.CodeBuild.UpdateWebhook

Methods

rnf :: UpdateWebhook -> ()

Eq UpdateWebhook

Defined in Amazonka.CodeBuild.UpdateWebhook

Methods

(==) :: UpdateWebhook -> UpdateWebhook -> Bool

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

Hashable UpdateWebhook

Defined in Amazonka.CodeBuild.UpdateWebhook

Methods

hashWithSalt :: Int -> UpdateWebhook -> Int

hash :: UpdateWebhook -> Int

type AWSResponse UpdateWebhook

Defined in Amazonka.CodeBuild.UpdateWebhook

type AWSResponse UpdateWebhook = UpdateWebhookResponse

type Rep UpdateWebhook

Defined in Amazonka.CodeBuild.UpdateWebhook

type Rep UpdateWebhook = D1 ('MetaData "UpdateWebhook" "Amazonka.CodeBuild.UpdateWebhook" "amazonka-codebuild-2.0-3KpZspRk9Ul8Wu4D0cM13Q" 'False) (C1 ('MetaCons "UpdateWebhook'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "branchFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "buildType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WebhookBuildType))) :*: (S1 ('MetaSel ('Just "filterGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [[WebhookFilter]])) :*: (S1 ('MetaSel ('Just "rotateSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "projectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateWebhook

Arguments

:: Text

UpdateWebhook

-> UpdateWebhook

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

UpdateWebhook, updateWebhook_branchFilter - A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.

It is recommended that you use filterGroups instead of branchFilter.

UpdateWebhook, updateWebhook_buildType - Specifies the type of build this webhook will trigger.

UpdateWebhook, updateWebhook_filterGroups - An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a build. A filter group must contain at least one EVENT WebhookFilter.

$sel:rotateSecret:UpdateWebhook', updateWebhook_rotateSecret - A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, rotateSecret is ignored.

UpdateWebhook, updateWebhook_projectName - The name of the CodeBuild project.

Request Lenses

updateWebhook_branchFilter :: Lens' UpdateWebhook (Maybe Text)

A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.

It is recommended that you use filterGroups instead of branchFilter.

updateWebhook_buildType :: Lens' UpdateWebhook (Maybe WebhookBuildType)

Specifies the type of build this webhook will trigger.

updateWebhook_filterGroups :: Lens' UpdateWebhook (Maybe [[WebhookFilter]])

An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a build. A filter group must contain at least one EVENT WebhookFilter.

updateWebhook_rotateSecret :: Lens' UpdateWebhook (Maybe Bool)

A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, rotateSecret is ignored.

updateWebhook_projectName :: Lens' UpdateWebhook Text

The name of the CodeBuild project.

Destructuring the Response

data UpdateWebhookResponse

See: newUpdateWebhookResponse smart constructor.

Constructors

UpdateWebhookResponse'

Fields

• webhook :: Maybe Webhook

  Information about a repository's webhook that is associated with a project in CodeBuild.

• httpStatus :: Int

  The response's http status code.

Instances

Generic UpdateWebhookResponse

Defined in Amazonka.CodeBuild.UpdateWebhook

Associated Types

type Rep UpdateWebhookResponse :: Type -> Type

Methods

from :: UpdateWebhookResponse -> Rep UpdateWebhookResponse x

to :: Rep UpdateWebhookResponse x -> UpdateWebhookResponse

Read UpdateWebhookResponse

Defined in Amazonka.CodeBuild.UpdateWebhook

Methods

readsPrec :: Int -> ReadS UpdateWebhookResponse

readList :: ReadS [UpdateWebhookResponse]

readPrec :: ReadPrec UpdateWebhookResponse

readListPrec :: ReadPrec [UpdateWebhookResponse]

Show UpdateWebhookResponse

Defined in Amazonka.CodeBuild.UpdateWebhook

Methods

showsPrec :: Int -> UpdateWebhookResponse -> ShowS

show :: UpdateWebhookResponse -> String

showList :: [UpdateWebhookResponse] -> ShowS

NFData UpdateWebhookResponse

Defined in Amazonka.CodeBuild.UpdateWebhook

Methods

rnf :: UpdateWebhookResponse -> ()

Eq UpdateWebhookResponse

Defined in Amazonka.CodeBuild.UpdateWebhook

Methods

(==) :: UpdateWebhookResponse -> UpdateWebhookResponse -> Bool

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

type Rep UpdateWebhookResponse

Defined in Amazonka.CodeBuild.UpdateWebhook

type Rep UpdateWebhookResponse = D1 ('MetaData "UpdateWebhookResponse" "Amazonka.CodeBuild.UpdateWebhook" "amazonka-codebuild-2.0-3KpZspRk9Ul8Wu4D0cM13Q" 'False) (C1 ('MetaCons "UpdateWebhookResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "webhook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Webhook)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateWebhookResponse

Arguments

:: Int

$sel:httpStatus:UpdateWebhookResponse'

-> UpdateWebhookResponse

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

UpdateWebhookResponse, updateWebhookResponse_webhook - Information about a repository's webhook that is associated with a project in CodeBuild.

$sel:httpStatus:UpdateWebhookResponse', updateWebhookResponse_httpStatus - The response's http status code.

Response Lenses

updateWebhookResponse_webhook :: Lens' UpdateWebhookResponse (Maybe Webhook)

Information about a repository's webhook that is associated with a project in CodeBuild.

updateWebhookResponse_httpStatus :: Lens' UpdateWebhookResponse Int

The response's http status code.