Network.AWS.CloudWatchEvents.PutTargets

Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.

Targets are the resources that are invoked when a rule is triggered.

You can configure the following as targets for CloudWatch Events:

• EC2 instances
• AWS Lambda functions
• Streams in Amazon Kinesis Streams
• Delivery streams in Amazon Kinesis Firehose
• Amazon ECS tasks
• AWS Step Functions state machines
• Pipelines in Amazon Code Pipeline
• Amazon Inspector assessment templates
• Amazon SNS topics
• Amazon SQS queues
• The default event bus of another AWS account

Note that creating rules with built-in targets is supported only in the AWS Management Console.

For some target types, PutTargets provides target-specific parameters. If the target is an Amazon Kinesis stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.

To be able to make API calls against the resources that you own, Amazon CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, CloudWatch Events relies on resource-based policies. For EC2 instances, Amazon Kinesis streams, and AWS Step Functions state machines, CloudWatch Events relies on IAM roles that you specify in the RoleARN argument in PutTargets . For more information, see Authentication and Access Control in the Amazon CloudWatch Events User Guide .

If another AWS account is in the same region and has granted you permission (using PutPermission ), you can send events to that account by setting that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn when you run PutTargets . If your account sends events to another account, your account is charged for each sent event. Each event sent to antoher account is charged as a custom event. The account receiving the event is not charged. For more information on pricing, see Amazon CloudWatch Pricing .

For more information about enabling cross-account events, see PutPermission .

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

• If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON form (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
• If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
• If InputPath is specified in the form of JSONPath (for example, > .detail ), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).
• If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.

When you specify Input , InputPath , or InputTransformer , you must use JSON dot notation, not bracket notation.

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

This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.

Creating a Request

putTargets

Arguments

:: Text

ptRule

-> NonEmpty Target

ptTargets

-> 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 - The name of the rule.
• ptTargets - The targets to update or add to the rule.

data PutTargets

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

Hashable PutTargets

Methods

hashWithSalt :: Int -> PutTargets -> Int

hash :: PutTargets -> Int

ToJSON PutTargets

Methods

toJSON :: PutTargets -> Value

toEncoding :: PutTargets -> Encoding

toJSONList :: [PutTargets] -> Value

toEncodingList :: [PutTargets] -> Encoding

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)

ToQuery PutTargets

Methods

toQuery :: PutTargets -> QueryString

ToPath PutTargets

Methods

toPath :: PutTargets -> ByteString

ToHeaders PutTargets

Methods

toHeaders :: PutTargets -> [Header]

type Rep PutTargets

type Rep PutTargets = D1 (MetaData "PutTargets" "Network.AWS.CloudWatchEvents.PutTargets" "amazonka-cloudwatch-events-1.5.0-45UlPAa7R14ChwLoYVg3Ab" 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 (List1 Target)))))

type Rs PutTargets

type Rs PutTargets = PutTargetsResponse

Request Lenses

ptRule :: Lens' PutTargets Text

The name of the rule.

ptTargets :: Lens' PutTargets (NonEmpty Target)

The targets 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 - The number of failed entries.
• ptrsFailedEntries - The failed target entries.
• ptrsResponseStatus - -- | The response status code.

data PutTargetsResponse

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.5.0-45UlPAa7R14ChwLoYVg3Ab" 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]

The failed target entries.

ptrsResponseStatus :: Lens' PutTargetsResponse Int

• - | The response status code.