Amazonka.CloudWatchEvents.DisableRule

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.

Creating a Request

data DisableRule

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

ToJSON DisableRule

Defined in Amazonka.CloudWatchEvents.DisableRule

Methods

toJSON :: DisableRule -> Value

toEncoding :: DisableRule -> Encoding

toJSONList :: [DisableRule] -> Value

toEncodingList :: [DisableRule] -> Encoding

ToHeaders DisableRule

Defined in Amazonka.CloudWatchEvents.DisableRule

Methods

toHeaders :: DisableRule -> [Header]

ToPath DisableRule

Defined in Amazonka.CloudWatchEvents.DisableRule

Methods

toPath :: DisableRule -> ByteString

ToQuery DisableRule

Defined in Amazonka.CloudWatchEvents.DisableRule

Methods

toQuery :: DisableRule -> QueryString

AWSRequest DisableRule

Defined in Amazonka.CloudWatchEvents.DisableRule

Associated Types

type AWSResponse DisableRule

Methods

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

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

Generic DisableRule

Defined in Amazonka.CloudWatchEvents.DisableRule

Associated Types

type Rep DisableRule :: Type -> Type

Methods

from :: DisableRule -> Rep DisableRule x

to :: Rep DisableRule x -> DisableRule

Read DisableRule

Defined in Amazonka.CloudWatchEvents.DisableRule

Methods

readsPrec :: Int -> ReadS DisableRule

readList :: ReadS [DisableRule]

readPrec :: ReadPrec DisableRule

readListPrec :: ReadPrec [DisableRule]

Show DisableRule

Defined in Amazonka.CloudWatchEvents.DisableRule

Methods

showsPrec :: Int -> DisableRule -> ShowS

show :: DisableRule -> String

showList :: [DisableRule] -> ShowS

NFData DisableRule

Defined in Amazonka.CloudWatchEvents.DisableRule

Methods

rnf :: DisableRule -> ()

Eq DisableRule

Defined in Amazonka.CloudWatchEvents.DisableRule

Methods

(==) :: DisableRule -> DisableRule -> Bool

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

Hashable DisableRule

Defined in Amazonka.CloudWatchEvents.DisableRule

Methods

hashWithSalt :: Int -> DisableRule -> Int

hash :: DisableRule -> Int

type AWSResponse DisableRule

Defined in Amazonka.CloudWatchEvents.DisableRule

type AWSResponse DisableRule = DisableRuleResponse

type Rep DisableRule

Defined in Amazonka.CloudWatchEvents.DisableRule

type Rep DisableRule = D1 ('MetaData "DisableRule" "Amazonka.CloudWatchEvents.DisableRule" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" '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)))

newDisableRule

Arguments

:: Text

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:

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.

DisableRule, disableRule_name - The name of the rule.

Request Lenses

disableRule_eventBusName :: Lens' DisableRule (Maybe Text)

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

The name of the rule.

Destructuring the Response

data DisableRuleResponse

See: newDisableRuleResponse smart constructor.

Constructors

DisableRuleResponse'

Instances

Generic DisableRuleResponse

Defined in Amazonka.CloudWatchEvents.DisableRule

Associated Types

type Rep DisableRuleResponse :: Type -> Type

Methods

from :: DisableRuleResponse -> Rep DisableRuleResponse x

to :: Rep DisableRuleResponse x -> DisableRuleResponse

Read DisableRuleResponse

Defined in Amazonka.CloudWatchEvents.DisableRule

Methods

readsPrec :: Int -> ReadS DisableRuleResponse

readList :: ReadS [DisableRuleResponse]

readPrec :: ReadPrec DisableRuleResponse

readListPrec :: ReadPrec [DisableRuleResponse]

Show DisableRuleResponse

Defined in Amazonka.CloudWatchEvents.DisableRule

Methods

showsPrec :: Int -> DisableRuleResponse -> ShowS

show :: DisableRuleResponse -> String

showList :: [DisableRuleResponse] -> ShowS

NFData DisableRuleResponse

Defined in Amazonka.CloudWatchEvents.DisableRule

Methods

rnf :: DisableRuleResponse -> ()

Eq DisableRuleResponse

Defined in Amazonka.CloudWatchEvents.DisableRule

Methods

(==) :: DisableRuleResponse -> DisableRuleResponse -> Bool

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

type Rep DisableRuleResponse

Defined in Amazonka.CloudWatchEvents.DisableRule

type Rep DisableRuleResponse = D1 ('MetaData "DisableRuleResponse" "Amazonka.CloudWatchEvents.DisableRule" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "DisableRuleResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDisableRuleResponse :: DisableRuleResponse

Create a value of DisableRuleResponse with all optional fields omitted.

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