Trait rusoto_events::CloudWatchEvents [−] [src]

pub trait CloudWatchEvents {
    fn delete_rule(
        &self, 
        input: &DeleteRuleRequest
    ) -> Result<(), DeleteRuleError>;
    fn describe_rule(
        &self, 
        input: &DescribeRuleRequest
    ) -> Result<DescribeRuleResponse, DescribeRuleError>;
    fn disable_rule(
        &self, 
        input: &DisableRuleRequest
    ) -> Result<(), DisableRuleError>;
    fn enable_rule(
        &self, 
        input: &EnableRuleRequest
    ) -> Result<(), EnableRuleError>;
    fn list_rule_names_by_target(
        &self, 
        input: &ListRuleNamesByTargetRequest
    ) -> Result<ListRuleNamesByTargetResponse, ListRuleNamesByTargetError>;
    fn list_rules(
        &self, 
        input: &ListRulesRequest
    ) -> Result<ListRulesResponse, ListRulesError>;
    fn list_targets_by_rule(
        &self, 
        input: &ListTargetsByRuleRequest
    ) -> Result<ListTargetsByRuleResponse, ListTargetsByRuleError>;
    fn put_events(
        &self, 
        input: &PutEventsRequest
    ) -> Result<PutEventsResponse, PutEventsError>;
    fn put_rule(
        &self, 
        input: &PutRuleRequest
    ) -> Result<PutRuleResponse, PutRuleError>;
    fn put_targets(
        &self, 
        input: &PutTargetsRequest
    ) -> Result<PutTargetsResponse, PutTargetsError>;
    fn remove_targets(
        &self, 
        input: &RemoveTargetsRequest
    ) -> Result<RemoveTargetsResponse, RemoveTargetsError>;
    fn test_event_pattern(
        &self, 
        input: &TestEventPatternRequest
    ) -> Result<TestEventPatternResponse, TestEventPatternError>;
}

Trait representing the capabilities of the Amazon CloudWatch Events API. Amazon CloudWatch Events clients implement this trait.

Required Methods

Deletes the specified rule.

You must remove all targets from a rule using RemoveTargets before you can delete the rule.

When you delete a rule, incoming events might continue to match to the deleted rule. Please allow a short period of time for changes to take effect.

Describes the specified rule.

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. Please allow a short period of time for changes to take effect.

Enables the specified rule. If the rule does not exist, the operation fails.

When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Please allow a short period of time for changes to take effect.

Lists the rules for the specified target. You can see which of the rules in Amazon CloudWatch Events can invoke a specific target in your account.

Lists your Amazon CloudWatch Events rules. You can either list all the rules or you can provide a prefix to match to the rule names.

Lists the targets assigned to the specified rule.

Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.

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.

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.

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. Example targets include EC2 instances, AWS Lambda functions, Amazon Kinesis streams, Amazon ECS tasks, AWS Step Functions state machines, and built-in targets. 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 PutTarget. For more information, see Authentication and Access Control in the Amazon CloudWatch Events User Guide.

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.

Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.

When you remove a target, when the associated rule triggers, removed targets might continue to be 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.

Tests whether the specified event pattern matches the provided event.

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.

Implementors