baiji v0.6.5 Baiji.CloudwatchEvents
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.
Link to this section Summary
Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
Deletes the specified rule
Displays the external AWS accounts that are permitted to write events to
your account using your account’s event bus, and the associated policy. To
enable your account to receive events from other accounts, use
PutPermission
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
Enables the specified rule. If the rule does not exist, the operation fails
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
Running PutPermission
permits the specified AWS account to put events to
your account’s default event bus. CloudWatch Events rules in your account
are triggered by these events arriving to your default event bus
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
Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule
Revokes the permission of another AWS account to be able to put events to
your default event bus. Specify the account to revoke by the StatementId
value that you associated with the account when you granted it permission
with PutPermission
. You can find the StatementId
by using
DescribeEventBus
Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked
Tests whether the specified event pattern matches the provided event
Link to this section Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
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.
Displays the external AWS accounts that are permitted to write events to
your account using your account’s event bus, and the associated policy. To
enable your account to receive events from other accounts, use
PutPermission
.
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.
Running PutPermission
permits the specified AWS account to put events to
your account’s default event bus. CloudWatch Events rules in your account
are triggered by these events arriving to your default event bus.
For another account to send events to your account, that external account must have a CloudWatch Events rule with your account’s default event bus as a target.
To enable multiple AWS accounts to put events to your default event bus,
run PutPermission
once for each of these accounts.
The permission policy on the default event bus cannot exceed 10KB in size.
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.
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
- 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.
Revokes the permission of another AWS account to be able to put events to
your default event bus. Specify the account to revoke by the StatementId
value that you associated with the account when you granted it permission
with PutPermission
. You can find the StatementId
by using
DescribeEventBus
.
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.