Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CodeStarNotifications.UpdateNotificationRule

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a notification rule for a resource. You can change the events that trigger the notification rule, the status of the rule, and the targets that receive the notifications.

To add or remove tags for a notification rule, you must use TagResource and UntagResource.

Synopsis

data UpdateNotificationRule = UpdateNotificationRule' {
- detailType :: Maybe DetailType
- eventTypeIds :: Maybe [Text]
- name :: Maybe (Sensitive Text)
- status :: Maybe NotificationRuleStatus
- targets :: Maybe [Target]
- arn :: Text
}
newUpdateNotificationRule :: Text -> UpdateNotificationRule
updateNotificationRule_detailType :: Lens' UpdateNotificationRule (Maybe DetailType)
updateNotificationRule_eventTypeIds :: Lens' UpdateNotificationRule (Maybe [Text])
updateNotificationRule_name :: Lens' UpdateNotificationRule (Maybe Text)
updateNotificationRule_status :: Lens' UpdateNotificationRule (Maybe NotificationRuleStatus)
updateNotificationRule_targets :: Lens' UpdateNotificationRule (Maybe [Target])
updateNotificationRule_arn :: Lens' UpdateNotificationRule Text
data UpdateNotificationRuleResponse = UpdateNotificationRuleResponse' {
- httpStatus :: Int
}
newUpdateNotificationRuleResponse :: Int -> UpdateNotificationRuleResponse
updateNotificationRuleResponse_httpStatus :: Lens' UpdateNotificationRuleResponse Int

Creating a Request

data UpdateNotificationRule Source #

See: newUpdateNotificationRule smart constructor.

Constructors

UpdateNotificationRule'

Fields

detailType :: Maybe DetailType
The level of detail to include in the notifications for this resource. BASIC will include only the contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.
eventTypeIds :: Maybe [Text]
A list of event types associated with this notification rule. For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.
name :: Maybe (Sensitive Text)
The name of the notification rule.
status :: Maybe NotificationRuleStatus
The status of the notification rule. Valid statuses include enabled (sending notifications) or disabled (not sending notifications).
targets :: Maybe [Target]
The address and type of the targets to receive notifications from this notification rule.
arn :: Text
The Amazon Resource Name (ARN) of the notification rule.

Instances

Instances details

ToJSON UpdateNotificationRule Source #
Instance details Defined in Amazonka.CodeStarNotifications.UpdateNotificationRule Methods toJSON :: UpdateNotificationRule -> Value # toEncoding :: UpdateNotificationRule -> Encoding # toJSONList :: [UpdateNotificationRule] -> Value # toEncodingList :: [UpdateNotificationRule] -> Encoding #
ToHeaders UpdateNotificationRule Source #
Instance details Defined in Amazonka.CodeStarNotifications.UpdateNotificationRule Methods toHeaders :: UpdateNotificationRule -> [Header] #
ToPath UpdateNotificationRule Source #
Instance details Defined in Amazonka.CodeStarNotifications.UpdateNotificationRule Methods toPath :: UpdateNotificationRule -> ByteString #
ToQuery UpdateNotificationRule Source #
Instance details Defined in Amazonka.CodeStarNotifications.UpdateNotificationRule Methods toQuery :: UpdateNotificationRule -> QueryString #
AWSRequest UpdateNotificationRule Source #
Instance details Defined in Amazonka.CodeStarNotifications.UpdateNotificationRule Associated Types type AWSResponse UpdateNotificationRule # Methods request :: (Service -> Service) -> UpdateNotificationRule -> Request UpdateNotificationRule # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateNotificationRule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateNotificationRule))) #
Generic UpdateNotificationRule Source #
Instance details Defined in Amazonka.CodeStarNotifications.UpdateNotificationRule Associated Types type Rep UpdateNotificationRule :: Type -> Type # Methods from :: UpdateNotificationRule -> Rep UpdateNotificationRule x # to :: Rep UpdateNotificationRule x -> UpdateNotificationRule #
Show UpdateNotificationRule Source #
Instance details Defined in Amazonka.CodeStarNotifications.UpdateNotificationRule Methods showsPrec :: Int -> UpdateNotificationRule -> ShowS # show :: UpdateNotificationRule -> String # showList :: [UpdateNotificationRule] -> ShowS #
NFData UpdateNotificationRule Source #
Instance details Defined in Amazonka.CodeStarNotifications.UpdateNotificationRule Methods rnf :: UpdateNotificationRule -> () #
Eq UpdateNotificationRule Source #
Instance details Defined in Amazonka.CodeStarNotifications.UpdateNotificationRule Methods (==) :: UpdateNotificationRule -> UpdateNotificationRule -> Bool # (/=) :: UpdateNotificationRule -> UpdateNotificationRule -> Bool #
Hashable UpdateNotificationRule Source #
Instance details Defined in Amazonka.CodeStarNotifications.UpdateNotificationRule Methods hashWithSalt :: Int -> UpdateNotificationRule -> Int # hash :: UpdateNotificationRule -> Int #
type AWSResponse UpdateNotificationRule Source #
Instance details Defined in Amazonka.CodeStarNotifications.UpdateNotificationRule type AWSResponse UpdateNotificationRule = UpdateNotificationRuleResponse
type Rep UpdateNotificationRule Source #
Instance details Defined in Amazonka.CodeStarNotifications.UpdateNotificationRule type Rep UpdateNotificationRule = D1 ('MetaData "UpdateNotificationRule" "Amazonka.CodeStarNotifications.UpdateNotificationRule" "amazonka-codestar-notifications-2.0-1YU4g2Ny2gz2roMHW6JQnw" 'False) (C1 ('MetaCons "UpdateNotificationRule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "detailType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DetailType)) :: (S1 ('MetaSel ('Just "eventTypeIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationRuleStatus)) :: (S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Target])) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateNotificationRule Source #

Arguments

:: Text	`UpdateNotificationRule`
-> UpdateNotificationRule

Create a value of UpdateNotificationRule 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:detailType:UpdateNotificationRule', updateNotificationRule_detailType - The level of detail to include in the notifications for this resource. BASIC will include only the contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

$sel:eventTypeIds:UpdateNotificationRule', updateNotificationRule_eventTypeIds - A list of event types associated with this notification rule. For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.

UpdateNotificationRule, updateNotificationRule_name - The name of the notification rule.

$sel:status:UpdateNotificationRule', updateNotificationRule_status - The status of the notification rule. Valid statuses include enabled (sending notifications) or disabled (not sending notifications).

$sel:targets:UpdateNotificationRule', updateNotificationRule_targets - The address and type of the targets to receive notifications from this notification rule.

UpdateNotificationRule, updateNotificationRule_arn - The Amazon Resource Name (ARN) of the notification rule.

Request Lenses

updateNotificationRule_detailType :: Lens' UpdateNotificationRule (Maybe DetailType) Source #

The level of detail to include in the notifications for this resource. BASIC will include only the contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

updateNotificationRule_eventTypeIds :: Lens' UpdateNotificationRule (Maybe [Text]) Source #

A list of event types associated with this notification rule. For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.

updateNotificationRule_name :: Lens' UpdateNotificationRule (Maybe Text) Source #

The name of the notification rule.

updateNotificationRule_status :: Lens' UpdateNotificationRule (Maybe NotificationRuleStatus) Source #

The status of the notification rule. Valid statuses include enabled (sending notifications) or disabled (not sending notifications).

updateNotificationRule_targets :: Lens' UpdateNotificationRule (Maybe [Target]) Source #

The address and type of the targets to receive notifications from this notification rule.

updateNotificationRule_arn :: Lens' UpdateNotificationRule Text Source #

The Amazon Resource Name (ARN) of the notification rule.

Destructuring the Response

data UpdateNotificationRuleResponse Source #

See: newUpdateNotificationRuleResponse smart constructor.

Constructors

UpdateNotificationRuleResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateNotificationRuleResponse Source #
Instance details Defined in Amazonka.CodeStarNotifications.UpdateNotificationRule Associated Types type Rep UpdateNotificationRuleResponse :: Type -> Type # Methods from :: UpdateNotificationRuleResponse -> Rep UpdateNotificationRuleResponse x # to :: Rep UpdateNotificationRuleResponse x -> UpdateNotificationRuleResponse #
Read UpdateNotificationRuleResponse Source #
Instance details Defined in Amazonka.CodeStarNotifications.UpdateNotificationRule Methods readsPrec :: Int -> ReadS UpdateNotificationRuleResponse # readList :: ReadS [UpdateNotificationRuleResponse] # readPrec :: ReadPrec UpdateNotificationRuleResponse # readListPrec :: ReadPrec [UpdateNotificationRuleResponse] #
Show UpdateNotificationRuleResponse Source #
Instance details Defined in Amazonka.CodeStarNotifications.UpdateNotificationRule Methods showsPrec :: Int -> UpdateNotificationRuleResponse -> ShowS # show :: UpdateNotificationRuleResponse -> String # showList :: [UpdateNotificationRuleResponse] -> ShowS #
NFData UpdateNotificationRuleResponse Source #
Instance details Defined in Amazonka.CodeStarNotifications.UpdateNotificationRule Methods rnf :: UpdateNotificationRuleResponse -> () #
Eq UpdateNotificationRuleResponse Source #
Instance details Defined in Amazonka.CodeStarNotifications.UpdateNotificationRule Methods (==) :: UpdateNotificationRuleResponse -> UpdateNotificationRuleResponse -> Bool # (/=) :: UpdateNotificationRuleResponse -> UpdateNotificationRuleResponse -> Bool #
type Rep UpdateNotificationRuleResponse Source #
Instance details Defined in Amazonka.CodeStarNotifications.UpdateNotificationRule type Rep UpdateNotificationRuleResponse = D1 ('MetaData "UpdateNotificationRuleResponse" "Amazonka.CodeStarNotifications.UpdateNotificationRule" "amazonka-codestar-notifications-2.0-1YU4g2Ny2gz2roMHW6JQnw" 'False) (C1 ('MetaCons "UpdateNotificationRuleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateNotificationRuleResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateNotificationRuleResponse'`
-> UpdateNotificationRuleResponse

Create a value of UpdateNotificationRuleResponse 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:httpStatus:UpdateNotificationRuleResponse', updateNotificationRuleResponse_httpStatus - The response's http status code.

Response Lenses

updateNotificationRuleResponse_httpStatus :: Lens' UpdateNotificationRuleResponse Int Source #

The response's http status code.