Network.AWS.CloudWatchEvents.PutRule

Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule .

If you are updating an existing rule, the rule is completely replaced with what you specify in this PutRule command. If you omit arguments in PutRule , the old values for those arguments are not kept. Instead, they are replaced with null values.

When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Please allow a short period of time for changes to take effect.

A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.

Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

Creating a Request

putRule

Arguments

:: Text

prName

-> PutRule

Creates a value of PutRule with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• prEventPattern - The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide .
• prState - Indicates whether the rule is enabled or disabled.
• prScheduleExpression - The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
• prDescription - A description of the rule.
• prRoleARN - The Amazon Resource Name (ARN) of the IAM role associated with the rule.
• prName - The name of the rule that you are creating or updating.

data PutRule

See: putRule smart constructor.

Instances

Eq PutRule

Defined in Network.AWS.CloudWatchEvents.PutRule

Methods

(==) :: PutRule -> PutRule -> Bool

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

Data PutRule

Defined in Network.AWS.CloudWatchEvents.PutRule

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutRule -> c PutRule

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutRule

toConstr :: PutRule -> Constr

dataTypeOf :: PutRule -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PutRule)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutRule)

gmapT :: (forall b. Data b => b -> b) -> PutRule -> PutRule

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutRule -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutRule -> r

gmapQ :: (forall d. Data d => d -> u) -> PutRule -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutRule -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutRule -> m PutRule

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutRule -> m PutRule

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutRule -> m PutRule

Read PutRule

Defined in Network.AWS.CloudWatchEvents.PutRule

Methods

readsPrec :: Int -> ReadS PutRule

readList :: ReadS [PutRule]

readPrec :: ReadPrec PutRule

readListPrec :: ReadPrec [PutRule]

Show PutRule

Defined in Network.AWS.CloudWatchEvents.PutRule

Methods

showsPrec :: Int -> PutRule -> ShowS

show :: PutRule -> String

showList :: [PutRule] -> ShowS

Generic PutRule

Defined in Network.AWS.CloudWatchEvents.PutRule

Associated Types

type Rep PutRule :: Type -> Type

Methods

from :: PutRule -> Rep PutRule x

to :: Rep PutRule x -> PutRule

Hashable PutRule

Defined in Network.AWS.CloudWatchEvents.PutRule

Methods

hashWithSalt :: Int -> PutRule -> Int

hash :: PutRule -> Int

ToJSON PutRule

Defined in Network.AWS.CloudWatchEvents.PutRule

Methods

toJSON :: PutRule -> Value

toEncoding :: PutRule -> Encoding

toJSONList :: [PutRule] -> Value

toEncodingList :: [PutRule] -> Encoding

AWSRequest PutRule

Defined in Network.AWS.CloudWatchEvents.PutRule

Associated Types

type Rs PutRule :: Type

Methods

request :: PutRule -> Request PutRule

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy PutRule -> ClientResponse -> m (Response PutRule)

ToHeaders PutRule

Defined in Network.AWS.CloudWatchEvents.PutRule

Methods

toHeaders :: PutRule -> [Header]

ToPath PutRule

Defined in Network.AWS.CloudWatchEvents.PutRule

Methods

toPath :: PutRule -> ByteString

ToQuery PutRule

Defined in Network.AWS.CloudWatchEvents.PutRule

Methods

toQuery :: PutRule -> QueryString

NFData PutRule

Defined in Network.AWS.CloudWatchEvents.PutRule

Methods

rnf :: PutRule -> ()

type Rep PutRule

Defined in Network.AWS.CloudWatchEvents.PutRule

type Rep PutRule = D1 (MetaData "PutRule" "Network.AWS.CloudWatchEvents.PutRule" "amazonka-cloudwatch-events-1.6.1-Gr8NdACzlKB7o8reClGMUI" False) (C1 (MetaCons "PutRule'" PrefixI True) ((S1 (MetaSel (Just "_prEventPattern") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_prState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RuleState)) :*: S1 (MetaSel (Just "_prScheduleExpression") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_prDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_prRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_prName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs PutRule

Defined in Network.AWS.CloudWatchEvents.PutRule

type Rs PutRule = PutRuleResponse

Request Lenses

prEventPattern :: Lens' PutRule (Maybe Text)

The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide .

prState :: Lens' PutRule (Maybe RuleState)

Indicates whether the rule is enabled or disabled.

prScheduleExpression :: Lens' PutRule (Maybe Text)

The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

prDescription :: Lens' PutRule (Maybe Text)

A description of the rule.

prRoleARN :: Lens' PutRule (Maybe Text)

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

prName :: Lens' PutRule Text

The name of the rule that you are creating or updating.

Destructuring the Response

putRuleResponse

Arguments

:: Int

prrsResponseStatus

-> PutRuleResponse

Creates a value of PutRuleResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• prrsRuleARN - The Amazon Resource Name (ARN) of the rule.
• prrsResponseStatus - -- | The response status code.

data PutRuleResponse

See: putRuleResponse smart constructor.

Instances

Eq PutRuleResponse

Defined in Network.AWS.CloudWatchEvents.PutRule

Methods

(==) :: PutRuleResponse -> PutRuleResponse -> Bool

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

Data PutRuleResponse

Defined in Network.AWS.CloudWatchEvents.PutRule

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutRuleResponse -> c PutRuleResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutRuleResponse

toConstr :: PutRuleResponse -> Constr

dataTypeOf :: PutRuleResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PutRuleResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutRuleResponse)

gmapT :: (forall b. Data b => b -> b) -> PutRuleResponse -> PutRuleResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutRuleResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutRuleResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> PutRuleResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutRuleResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutRuleResponse -> m PutRuleResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutRuleResponse -> m PutRuleResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutRuleResponse -> m PutRuleResponse

Read PutRuleResponse

Defined in Network.AWS.CloudWatchEvents.PutRule

Methods

readsPrec :: Int -> ReadS PutRuleResponse

readList :: ReadS [PutRuleResponse]

readPrec :: ReadPrec PutRuleResponse

readListPrec :: ReadPrec [PutRuleResponse]

Show PutRuleResponse

Defined in Network.AWS.CloudWatchEvents.PutRule

Methods

showsPrec :: Int -> PutRuleResponse -> ShowS

show :: PutRuleResponse -> String

showList :: [PutRuleResponse] -> ShowS

Generic PutRuleResponse

Defined in Network.AWS.CloudWatchEvents.PutRule

Associated Types

type Rep PutRuleResponse :: Type -> Type

Methods

from :: PutRuleResponse -> Rep PutRuleResponse x

to :: Rep PutRuleResponse x -> PutRuleResponse

NFData PutRuleResponse

Defined in Network.AWS.CloudWatchEvents.PutRule

Methods

rnf :: PutRuleResponse -> ()

type Rep PutRuleResponse

Defined in Network.AWS.CloudWatchEvents.PutRule

type Rep PutRuleResponse = D1 (MetaData "PutRuleResponse" "Network.AWS.CloudWatchEvents.PutRule" "amazonka-cloudwatch-events-1.6.1-Gr8NdACzlKB7o8reClGMUI" False) (C1 (MetaCons "PutRuleResponse'" PrefixI True) (S1 (MetaSel (Just "_prrsRuleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_prrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

prrsRuleARN :: Lens' PutRuleResponse (Maybe Text)

The Amazon Resource Name (ARN) of the rule.

prrsResponseStatus :: Lens' PutRuleResponse Int

• - | The response status code.