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.CloudWatchEvents.DisableRule

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression.

When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of time for changes to take effect.

Synopsis

data DisableRule = DisableRule' {
- eventBusName :: Maybe Text
- name :: Text
}
newDisableRule :: Text -> DisableRule
disableRule_eventBusName :: Lens' DisableRule (Maybe Text)
disableRule_name :: Lens' DisableRule Text
data DisableRuleResponse = DisableRuleResponse' {
}
newDisableRuleResponse :: DisableRuleResponse

Creating a Request

data DisableRule Source #

See: newDisableRule smart constructor.

Constructors

DisableRule'
Fields eventBusName :: Maybe Text The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used. name :: Text The name of the rule.

Instances

Instances details

Eq DisableRule Source #
Instance details Defined in Amazonka.CloudWatchEvents.DisableRule Methods (==) :: DisableRule -> DisableRule -> Bool # (/=) :: DisableRule -> DisableRule -> Bool #
Read DisableRule Source #
Instance details Defined in Amazonka.CloudWatchEvents.DisableRule Methods readsPrec :: Int -> ReadS DisableRule # readList :: ReadS [DisableRule] # readPrec :: ReadPrec DisableRule # readListPrec :: ReadPrec [DisableRule] #
Show DisableRule Source #
Instance details Defined in Amazonka.CloudWatchEvents.DisableRule Methods showsPrec :: Int -> DisableRule -> ShowS # show :: DisableRule -> String # showList :: [DisableRule] -> ShowS #
Generic DisableRule Source #
Instance details Defined in Amazonka.CloudWatchEvents.DisableRule Associated Types type Rep DisableRule :: Type -> Type # Methods from :: DisableRule -> Rep DisableRule x # to :: Rep DisableRule x -> DisableRule #
NFData DisableRule Source #
Instance details Defined in Amazonka.CloudWatchEvents.DisableRule Methods rnf :: DisableRule -> () #
Hashable DisableRule Source #
Instance details Defined in Amazonka.CloudWatchEvents.DisableRule Methods hashWithSalt :: Int -> DisableRule -> Int # hash :: DisableRule -> Int #
ToJSON DisableRule Source #
Instance details Defined in Amazonka.CloudWatchEvents.DisableRule Methods toJSON :: DisableRule -> Value # toEncoding :: DisableRule -> Encoding # toJSONList :: [DisableRule] -> Value # toEncodingList :: [DisableRule] -> Encoding #
AWSRequest DisableRule Source #
Instance details Defined in Amazonka.CloudWatchEvents.DisableRule Associated Types type AWSResponse DisableRule # Methods request :: DisableRule -> Request DisableRule # response :: MonadResource m => Logger -> Service -> Proxy DisableRule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DisableRule))) #
ToHeaders DisableRule Source #
Instance details Defined in Amazonka.CloudWatchEvents.DisableRule Methods toHeaders :: DisableRule -> [Header] #
ToPath DisableRule Source #
Instance details Defined in Amazonka.CloudWatchEvents.DisableRule Methods toPath :: DisableRule -> ByteString #
ToQuery DisableRule Source #
Instance details Defined in Amazonka.CloudWatchEvents.DisableRule Methods toQuery :: DisableRule -> QueryString #
type Rep DisableRule Source #
Instance details Defined in Amazonka.CloudWatchEvents.DisableRule type Rep DisableRule = D1 ('MetaData "DisableRule" "Amazonka.CloudWatchEvents.DisableRule" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "DisableRule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventBusName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DisableRule Source #
Instance details Defined in Amazonka.CloudWatchEvents.DisableRule type AWSResponse DisableRule = DisableRuleResponse

newDisableRule Source #

Arguments

:: Text	`$sel:name:DisableRule'`
-> DisableRule

Create a value of DisableRule 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:eventBusName:DisableRule', disableRule_eventBusName - The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

$sel:name:DisableRule', disableRule_name - The name of the rule.

Request Lenses

disableRule_eventBusName :: Lens' DisableRule (Maybe Text) Source #

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

disableRule_name :: Lens' DisableRule Text Source #

The name of the rule.

Destructuring the Response

data DisableRuleResponse Source #

See: newDisableRuleResponse smart constructor.

Constructors

DisableRuleResponse'

Instances

Instances details

Eq DisableRuleResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DisableRule Methods (==) :: DisableRuleResponse -> DisableRuleResponse -> Bool # (/=) :: DisableRuleResponse -> DisableRuleResponse -> Bool #
Read DisableRuleResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DisableRule Methods readsPrec :: Int -> ReadS DisableRuleResponse # readList :: ReadS [DisableRuleResponse] # readPrec :: ReadPrec DisableRuleResponse # readListPrec :: ReadPrec [DisableRuleResponse] #
Show DisableRuleResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DisableRule Methods showsPrec :: Int -> DisableRuleResponse -> ShowS # show :: DisableRuleResponse -> String # showList :: [DisableRuleResponse] -> ShowS #
Generic DisableRuleResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DisableRule Associated Types type Rep DisableRuleResponse :: Type -> Type # Methods from :: DisableRuleResponse -> Rep DisableRuleResponse x # to :: Rep DisableRuleResponse x -> DisableRuleResponse #
NFData DisableRuleResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DisableRule Methods rnf :: DisableRuleResponse -> () #
type Rep DisableRuleResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DisableRule type Rep DisableRuleResponse = D1 ('MetaData "DisableRuleResponse" "Amazonka.CloudWatchEvents.DisableRule" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "DisableRuleResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDisableRuleResponse :: DisableRuleResponse Source #

Create a value of DisableRuleResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.