amazonka-cloudwatch-events-1.4.5: Amazon CloudWatch Events SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CloudWatchEvents

Contents

Description

Amazon CloudWatch Events helps you to respond to state changes in your AWS resources. When your resources change state they automatically send events into an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a pre-determined schedule. For example, you can configure rules to:

  • Automatically invoke an AWS Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state. * Direct specific API records from CloudTrail to an Amazon Kinesis stream for detailed analysis of potential security or availability risks. * Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume.

For more information about Amazon CloudWatch Events features, see the Amazon CloudWatch Developer Guide .

Synopsis

Service Configuration

cloudWatchEvents :: Service #

API version 2015-10-07 of the Amazon CloudWatch Events SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by CloudWatchEvents.

ConcurrentModificationException

_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError #

This exception occurs if there is concurrent modification on rule or target.

InvalidEventPatternException

InternalException

_InternalException :: AsError a => Getting (First ServiceError) a ServiceError #

This exception occurs due to unexpected causes.

ResourceNotFoundException

LimitExceededException

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError #

This exception occurs if you try to create more rules or add more targets to a rule than allowed by default.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

RemoveTargets

DeleteRule

ListRules

PutRule

DisableRule

ListTargetsByRule

DescribeRule

EnableRule

ListRuleNamesByTarget

TestEventPattern

PutTargets

PutEvents

Types

RuleState

data RuleState #

Constructors

Disabled 
Enabled 

Instances

Bounded RuleState # 
Enum RuleState # 
Eq RuleState # 
Data RuleState # 

Methods

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

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

toConstr :: RuleState -> Constr #

dataTypeOf :: RuleState -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RuleState) #

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

gmapT :: (forall b. Data b => b -> b) -> RuleState -> RuleState #

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

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

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

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

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

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

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

Ord RuleState # 
Read RuleState # 
Show RuleState # 
Generic RuleState # 

Associated Types

type Rep RuleState :: * -> * #

Hashable RuleState # 
ToJSON RuleState # 
FromJSON RuleState # 
NFData RuleState # 

Methods

rnf :: RuleState -> () #

ToQuery RuleState # 
ToHeader RuleState # 
ToByteString RuleState # 

Methods

toBS :: RuleState -> ByteString #

FromText RuleState # 
ToText RuleState # 

Methods

toText :: RuleState -> Text #

type Rep RuleState # 
type Rep RuleState = D1 (MetaData "RuleState" "Network.AWS.CloudWatchEvents.Types.Sum" "amazonka-cloudwatch-events-1.4.5-6DdwNqzTXs3BVXIlURV4bz" False) ((:+:) (C1 (MetaCons "Disabled" PrefixI False) U1) (C1 (MetaCons "Enabled" PrefixI False) U1))

PutEventsRequestEntry

data PutEventsRequestEntry #

Contains information about the event to be used in PutEvents.

See: putEventsRequestEntry smart constructor.

Instances

Eq PutEventsRequestEntry # 
Data PutEventsRequestEntry # 

Methods

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

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

toConstr :: PutEventsRequestEntry -> Constr #

dataTypeOf :: PutEventsRequestEntry -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PutEventsRequestEntry) #

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

gmapT :: (forall b. Data b => b -> b) -> PutEventsRequestEntry -> PutEventsRequestEntry #

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

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

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

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

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

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

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

Read PutEventsRequestEntry # 
Show PutEventsRequestEntry # 
Generic PutEventsRequestEntry # 
Hashable PutEventsRequestEntry # 
ToJSON PutEventsRequestEntry # 
NFData PutEventsRequestEntry # 

Methods

rnf :: PutEventsRequestEntry -> () #

type Rep PutEventsRequestEntry # 
type Rep PutEventsRequestEntry = D1 (MetaData "PutEventsRequestEntry" "Network.AWS.CloudWatchEvents.Types.Product" "amazonka-cloudwatch-events-1.4.5-6DdwNqzTXs3BVXIlURV4bz" False) (C1 (MetaCons "PutEventsRequestEntry'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pereTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_pereDetailType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_pereResources") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_pereSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_pereDetail") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

putEventsRequestEntry :: PutEventsRequestEntry #

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

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

  • pereTime - Timestamp of event, per RFC3339 . If no timestamp is provided, the timestamp of the PutEvents call will be used.
  • pereDetailType - Free-form string used to decide what fields to expect in the event detail.
  • pereResources - AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
  • pereSource - The source of the event.
  • pereDetail - In the JSON sense, an object containing fields, which may also contain nested sub-objects. No constraints are imposed on its contents.

pereTime :: Lens' PutEventsRequestEntry (Maybe UTCTime) #

Timestamp of event, per RFC3339 . If no timestamp is provided, the timestamp of the PutEvents call will be used.

pereDetailType :: Lens' PutEventsRequestEntry (Maybe Text) #

Free-form string used to decide what fields to expect in the event detail.

pereResources :: Lens' PutEventsRequestEntry [Text] #

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.

pereSource :: Lens' PutEventsRequestEntry (Maybe Text) #

The source of the event.

pereDetail :: Lens' PutEventsRequestEntry (Maybe Text) #

In the JSON sense, an object containing fields, which may also contain nested sub-objects. No constraints are imposed on its contents.

PutEventsResultEntry

data PutEventsResultEntry #

A PutEventsResult contains a list of PutEventsResultEntry.

See: putEventsResultEntry smart constructor.

Instances

Eq PutEventsResultEntry # 
Data PutEventsResultEntry # 

Methods

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

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

toConstr :: PutEventsResultEntry -> Constr #

dataTypeOf :: PutEventsResultEntry -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PutEventsResultEntry) #

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

gmapT :: (forall b. Data b => b -> b) -> PutEventsResultEntry -> PutEventsResultEntry #

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

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

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

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

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

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

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

Read PutEventsResultEntry # 
Show PutEventsResultEntry # 
Generic PutEventsResultEntry # 
Hashable PutEventsResultEntry # 
FromJSON PutEventsResultEntry # 
NFData PutEventsResultEntry # 

Methods

rnf :: PutEventsResultEntry -> () #

type Rep PutEventsResultEntry # 
type Rep PutEventsResultEntry = D1 (MetaData "PutEventsResultEntry" "Network.AWS.CloudWatchEvents.Types.Product" "amazonka-cloudwatch-events-1.4.5-6DdwNqzTXs3BVXIlURV4bz" False) (C1 (MetaCons "PutEventsResultEntry'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_pereErrorCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_pereErrorMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_pereEventId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

putEventsResultEntry :: PutEventsResultEntry #

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

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

  • pereErrorCode - The error code representing why the event submission failed on this entry.
  • pereErrorMessage - The error message explaining why the event submission failed on this entry.
  • pereEventId - The ID of the event submitted to Amazon CloudWatch Events.

pereErrorCode :: Lens' PutEventsResultEntry (Maybe Text) #

The error code representing why the event submission failed on this entry.

pereErrorMessage :: Lens' PutEventsResultEntry (Maybe Text) #

The error message explaining why the event submission failed on this entry.

pereEventId :: Lens' PutEventsResultEntry (Maybe Text) #

The ID of the event submitted to Amazon CloudWatch Events.

PutTargetsResultEntry

data PutTargetsResultEntry #

A PutTargetsResult contains a list of PutTargetsResultEntry.

See: putTargetsResultEntry smart constructor.

Instances

Eq PutTargetsResultEntry # 
Data PutTargetsResultEntry # 

Methods

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

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

toConstr :: PutTargetsResultEntry -> Constr #

dataTypeOf :: PutTargetsResultEntry -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PutTargetsResultEntry) #

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

gmapT :: (forall b. Data b => b -> b) -> PutTargetsResultEntry -> PutTargetsResultEntry #

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

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

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

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

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

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

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

Read PutTargetsResultEntry # 
Show PutTargetsResultEntry # 
Generic PutTargetsResultEntry # 
Hashable PutTargetsResultEntry # 
FromJSON PutTargetsResultEntry # 
NFData PutTargetsResultEntry # 

Methods

rnf :: PutTargetsResultEntry -> () #

type Rep PutTargetsResultEntry # 
type Rep PutTargetsResultEntry = D1 (MetaData "PutTargetsResultEntry" "Network.AWS.CloudWatchEvents.Types.Product" "amazonka-cloudwatch-events-1.4.5-6DdwNqzTXs3BVXIlURV4bz" False) (C1 (MetaCons "PutTargetsResultEntry'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ptreTargetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ptreErrorCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ptreErrorMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

putTargetsResultEntry :: PutTargetsResultEntry #

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

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

  • ptreTargetId - The ID of the target submitted to Amazon CloudWatch Events.
  • ptreErrorCode - The error code representing why the target submission failed on this entry.
  • ptreErrorMessage - The error message explaining why the target submission failed on this entry.

ptreTargetId :: Lens' PutTargetsResultEntry (Maybe Text) #

The ID of the target submitted to Amazon CloudWatch Events.

ptreErrorCode :: Lens' PutTargetsResultEntry (Maybe Text) #

The error code representing why the target submission failed on this entry.

ptreErrorMessage :: Lens' PutTargetsResultEntry (Maybe Text) #

The error message explaining why the target submission failed on this entry.

RemoveTargetsResultEntry

data RemoveTargetsResultEntry #

The ID of the target requested to be removed from the rule by Amazon CloudWatch Events.

See: removeTargetsResultEntry smart constructor.

Instances

Eq RemoveTargetsResultEntry # 
Data RemoveTargetsResultEntry # 

Methods

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

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

toConstr :: RemoveTargetsResultEntry -> Constr #

dataTypeOf :: RemoveTargetsResultEntry -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RemoveTargetsResultEntry) #

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

gmapT :: (forall b. Data b => b -> b) -> RemoveTargetsResultEntry -> RemoveTargetsResultEntry #

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

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

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

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

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

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

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

Read RemoveTargetsResultEntry # 
Show RemoveTargetsResultEntry # 
Generic RemoveTargetsResultEntry # 
Hashable RemoveTargetsResultEntry # 
FromJSON RemoveTargetsResultEntry # 
NFData RemoveTargetsResultEntry # 
type Rep RemoveTargetsResultEntry # 
type Rep RemoveTargetsResultEntry = D1 (MetaData "RemoveTargetsResultEntry" "Network.AWS.CloudWatchEvents.Types.Product" "amazonka-cloudwatch-events-1.4.5-6DdwNqzTXs3BVXIlURV4bz" False) (C1 (MetaCons "RemoveTargetsResultEntry'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rtreTargetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_rtreErrorCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rtreErrorMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

removeTargetsResultEntry :: RemoveTargetsResultEntry #

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

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

  • rtreTargetId - The ID of the target requested to be removed by Amazon CloudWatch Events.
  • rtreErrorCode - The error code representing why the target removal failed on this entry.
  • rtreErrorMessage - The error message explaining why the target removal failed on this entry.

rtreTargetId :: Lens' RemoveTargetsResultEntry (Maybe Text) #

The ID of the target requested to be removed by Amazon CloudWatch Events.

rtreErrorCode :: Lens' RemoveTargetsResultEntry (Maybe Text) #

The error code representing why the target removal failed on this entry.

rtreErrorMessage :: Lens' RemoveTargetsResultEntry (Maybe Text) #

The error message explaining why the target removal failed on this entry.

Rule

data Rule #

Contains information about a rule in Amazon CloudWatch Events. A ListRulesResult contains a list of Rules.

See: rule smart constructor.

Instances

Eq Rule # 

Methods

(==) :: Rule -> Rule -> Bool #

(/=) :: Rule -> Rule -> Bool #

Data Rule # 

Methods

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

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

toConstr :: Rule -> Constr #

dataTypeOf :: Rule -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Rule) #

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

gmapT :: (forall b. Data b => b -> b) -> Rule -> Rule #

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

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

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

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

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

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

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

Read Rule # 
Show Rule # 

Methods

showsPrec :: Int -> Rule -> ShowS #

show :: Rule -> String #

showList :: [Rule] -> ShowS #

Generic Rule # 

Associated Types

type Rep Rule :: * -> * #

Methods

from :: Rule -> Rep Rule x #

to :: Rep Rule x -> Rule #

Hashable Rule # 

Methods

hashWithSalt :: Int -> Rule -> Int #

hash :: Rule -> Int #

FromJSON Rule # 
NFData Rule # 

Methods

rnf :: Rule -> () #

type Rep Rule # 

rule :: Rule #

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

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

  • rEventPattern - The event pattern of the rule.
  • rState - The rule's state.
  • rARN - The Amazon Resource Name (ARN) of the rule.
  • rScheduleExpression - The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
  • rName - The rule's name.
  • rDescription - The description of the rule.
  • rRoleARN - The Amazon Resource Name (ARN) associated with the role that is used for target invocation.

rEventPattern :: Lens' Rule (Maybe Text) #

The event pattern of the rule.

rState :: Lens' Rule (Maybe RuleState) #

The rule's state.

rARN :: Lens' Rule (Maybe Text) #

The Amazon Resource Name (ARN) of the rule.

rScheduleExpression :: Lens' Rule (Maybe Text) #

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

rName :: Lens' Rule (Maybe Text) #

The rule's name.

rDescription :: Lens' Rule (Maybe Text) #

The description of the rule.

rRoleARN :: Lens' Rule (Maybe Text) #

The Amazon Resource Name (ARN) associated with the role that is used for target invocation.

Target

data Target #

Targets are the resources that can be invoked when a rule is triggered. For example, AWS Lambda functions, Amazon Kinesis streams, and built-in targets.

Input and InputPath are mutually-exclusive and optional parameters of a target. When a rule is triggered due to a matched event, if for a target:

  • Neither Input nor InputPath is specified, then the entire event is passed to the target in JSON form. * InputPath is specified in the form of JSONPath (e.g. > .detail ), then only the part of the event specified in the path is passed to the target (e.g. only the detail part of the event is passed). * Input is specified in the form of a valid JSON, then the matched event is overridden with this constant.

See: target smart constructor.

Instances

Eq Target # 

Methods

(==) :: Target -> Target -> Bool #

(/=) :: Target -> Target -> Bool #

Data Target # 

Methods

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

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

toConstr :: Target -> Constr #

dataTypeOf :: Target -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Target) #

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

gmapT :: (forall b. Data b => b -> b) -> Target -> Target #

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

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

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

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

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

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

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

Read Target # 
Show Target # 
Generic Target # 

Associated Types

type Rep Target :: * -> * #

Methods

from :: Target -> Rep Target x #

to :: Rep Target x -> Target #

Hashable Target # 

Methods

hashWithSalt :: Int -> Target -> Int #

hash :: Target -> Int #

ToJSON Target # 
FromJSON Target # 
NFData Target # 

Methods

rnf :: Target -> () #

type Rep Target # 
type Rep Target = D1 (MetaData "Target" "Network.AWS.CloudWatchEvents.Types.Product" "amazonka-cloudwatch-events-1.4.5-6DdwNqzTXs3BVXIlURV4bz" False) (C1 (MetaCons "Target'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_tInput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_tInputPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_tId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_tARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

target #

Arguments

:: Text

tId

-> Text

tARN

-> Target 

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

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

tInput :: Lens' Target (Maybe Text) #

Valid JSON text passed to the target. For more information about JSON text, see The JavaScript Object Notation (JSON) Data Interchange Format .

tInputPath :: Lens' Target (Maybe Text) #

The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. For more information about JSON paths, see JSONPath .

tId :: Lens' Target Text #

The unique target assignment ID.

tARN :: Lens' Target Text #

The Amazon Resource Name (ARN) associated of the target.