Network.AWS.CloudWatchEvents.PutTargets

Adds target(s) to a rule. 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. Updates the target(s) if they are already associated with the role. In other words, if there is already a target with the given target ID, then the target associated with that ID is updated.

In order to be able to make API calls against the resources you own, Amazon CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, CloudWatch Events relies on resource-based policies. For Amazon Kinesis streams, CloudWatch Events relies on IAM roles. For more information, see Permissions for Sending Events to Targets in the Amazon CloudWatch Developer Guide.

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.

Note: When you add targets to a rule, when the associated rule triggers, new or updated targets might not be immediately invoked. Please allow a short period of time for changes to take effect.

Creating a Request

putTargets

Arguments

:: Text

ptRule

-> PutTargets

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

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

• ptRule
• ptTargets

data PutTargets

Container for the parameters to the PutTargets operation.

See: putTargets smart constructor.

Instances

Eq PutTargets

Methods

(==) :: PutTargets -> PutTargets -> Bool

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

Data PutTargets

Methods

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

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

toConstr :: PutTargets -> Constr

dataTypeOf :: PutTargets -> DataType

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

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

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

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

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

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

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

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

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

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

Read PutTargets

Methods

readsPrec :: Int -> ReadS PutTargets

readList :: ReadS [PutTargets]

readPrec :: ReadPrec PutTargets

readListPrec :: ReadPrec [PutTargets]

Show PutTargets

Methods

showsPrec :: Int -> PutTargets -> ShowS

show :: PutTargets -> String

showList :: [PutTargets] -> ShowS

Generic PutTargets

Associated Types

type Rep PutTargets :: * -> *

Methods

from :: PutTargets -> Rep PutTargets x

to :: Rep PutTargets x -> PutTargets

ToJSON PutTargets

Methods

toJSON :: PutTargets -> Value

toEncoding :: PutTargets -> Encoding

Hashable PutTargets

Methods

hashWithSalt :: Int -> PutTargets -> Int

hash :: PutTargets -> Int

NFData PutTargets

Methods

rnf :: PutTargets -> ()

AWSRequest PutTargets

Associated Types

type Rs PutTargets :: *

Methods

request :: PutTargets -> Request PutTargets

response :: MonadResource m => Logger -> Service -> Proxy * PutTargets -> ClientResponse -> m (Response PutTargets)

ToPath PutTargets

Methods

toPath :: PutTargets -> ByteString

ToHeaders PutTargets

Methods

toHeaders :: PutTargets -> [Header]

ToQuery PutTargets

Methods

toQuery :: PutTargets -> QueryString

type Rep PutTargets

type Rep PutTargets = D1 (MetaData "PutTargets" "Network.AWS.CloudWatchEvents.PutTargets" "amazonka-cloudwatch-events-1.4.2-KmLaaEmFLtVEb3hPLY8Pk4" False) (C1 (MetaCons "PutTargets'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ptRule") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ptTargets") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Target]))))

type Rs PutTargets

type Rs PutTargets = PutTargetsResponse

Request Lenses

ptRule :: Lens' PutTargets Text

The name of the rule you want to add targets to.

ptTargets :: Lens' PutTargets [Target]

List of targets you want to update or add to the rule.

Destructuring the Response

putTargetsResponse

Arguments

:: Int

ptrsResponseStatus

-> PutTargetsResponse

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

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

• ptrsFailedEntryCount
• ptrsFailedEntries
• ptrsResponseStatus

data PutTargetsResponse

The result of the PutTargets operation.

See: putTargetsResponse smart constructor.

Instances

Eq PutTargetsResponse

Methods

(==) :: PutTargetsResponse -> PutTargetsResponse -> Bool

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

Data PutTargetsResponse

Methods

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

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

toConstr :: PutTargetsResponse -> Constr

dataTypeOf :: PutTargetsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read PutTargetsResponse

Methods

readsPrec :: Int -> ReadS PutTargetsResponse

readList :: ReadS [PutTargetsResponse]

readPrec :: ReadPrec PutTargetsResponse

readListPrec :: ReadPrec [PutTargetsResponse]

Show PutTargetsResponse

Methods

showsPrec :: Int -> PutTargetsResponse -> ShowS

show :: PutTargetsResponse -> String

showList :: [PutTargetsResponse] -> ShowS

Generic PutTargetsResponse

Associated Types

type Rep PutTargetsResponse :: * -> *

Methods

from :: PutTargetsResponse -> Rep PutTargetsResponse x

to :: Rep PutTargetsResponse x -> PutTargetsResponse

NFData PutTargetsResponse

Methods

rnf :: PutTargetsResponse -> ()

type Rep PutTargetsResponse

type Rep PutTargetsResponse = D1 (MetaData "PutTargetsResponse" "Network.AWS.CloudWatchEvents.PutTargets" "amazonka-cloudwatch-events-1.4.2-KmLaaEmFLtVEb3hPLY8Pk4" False) (C1 (MetaCons "PutTargetsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ptrsFailedEntryCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) ((:*:) (S1 (MetaSel (Just Symbol "_ptrsFailedEntries") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PutTargetsResultEntry]))) (S1 (MetaSel (Just Symbol "_ptrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

ptrsFailedEntryCount :: Lens' PutTargetsResponse (Maybe Int)

The number of failed entries.

ptrsFailedEntries :: Lens' PutTargetsResponse [PutTargetsResultEntry]

An array of failed target entries.

ptrsResponseStatus :: Lens' PutTargetsResponse Int

The response status code.