Class: Aws::CloudWatchEvents::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CloudWatchEvents::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb
Overview
An API client for CloudWatchEvents. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::CloudWatchEvents::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#activate_event_source(params = {}) ⇒ Struct
Activates a partner event source that has been deactivated.
-
#cancel_replay(params = {}) ⇒ Types::CancelReplayResponse
Cancels the specified replay.
-
#create_api_destination(params = {}) ⇒ Types::CreateApiDestinationResponse
Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.
-
#create_archive(params = {}) ⇒ Types::CreateArchiveResponse
Creates an archive of events with the specified settings.
-
#create_connection(params = {}) ⇒ Types::CreateConnectionResponse
Creates a connection.
-
#create_event_bus(params = {}) ⇒ Types::CreateEventBusResponse
Creates a new event bus within your account.
-
#create_partner_event_source(params = {}) ⇒ Types::CreatePartnerEventSourceResponse
Called by an SaaS partner to create a partner event source.
-
#deactivate_event_source(params = {}) ⇒ Struct
You can use this operation to temporarily stop receiving events from the specified partner event source.
-
#deauthorize_connection(params = {}) ⇒ Types::DeauthorizeConnectionResponse
Removes all authorization parameters from the connection.
-
#delete_api_destination(params = {}) ⇒ Struct
Deletes the specified API destination.
-
#delete_archive(params = {}) ⇒ Struct
Deletes the specified archive.
-
#delete_connection(params = {}) ⇒ Types::DeleteConnectionResponse
Deletes a connection.
-
#delete_event_bus(params = {}) ⇒ Struct
Deletes the specified custom event bus or partner event bus.
-
#delete_partner_event_source(params = {}) ⇒ Struct
This operation is used by SaaS partners to delete a partner event source.
-
#delete_rule(params = {}) ⇒ Struct
Deletes the specified rule.
-
#describe_api_destination(params = {}) ⇒ Types::DescribeApiDestinationResponse
Retrieves details about an API destination.
-
#describe_archive(params = {}) ⇒ Types::DescribeArchiveResponse
Retrieves details about an archive.
-
#describe_connection(params = {}) ⇒ Types::DescribeConnectionResponse
Retrieves details about a connection.
-
#describe_event_bus(params = {}) ⇒ Types::DescribeEventBusResponse
Displays details about an event bus in your account.
-
#describe_event_source(params = {}) ⇒ Types::DescribeEventSourceResponse
This operation lists details about a partner event source that is shared with your account.
-
#describe_partner_event_source(params = {}) ⇒ Types::DescribePartnerEventSourceResponse
An SaaS partner can use this operation to list details about a partner event source that they have created.
-
#describe_replay(params = {}) ⇒ Types::DescribeReplayResponse
Retrieves details about a replay.
-
#describe_rule(params = {}) ⇒ Types::DescribeRuleResponse
Describes the specified rule.
-
#disable_rule(params = {}) ⇒ Struct
Disables the specified rule.
-
#enable_rule(params = {}) ⇒ Struct
Enables the specified rule.
-
#list_api_destinations(params = {}) ⇒ Types::ListApiDestinationsResponse
Retrieves a list of API destination in the account in the current Region.
-
#list_archives(params = {}) ⇒ Types::ListArchivesResponse
Lists your archives.
-
#list_connections(params = {}) ⇒ Types::ListConnectionsResponse
Retrieves a list of connections from the account.
-
#list_event_buses(params = {}) ⇒ Types::ListEventBusesResponse
Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.
-
#list_event_sources(params = {}) ⇒ Types::ListEventSourcesResponse
You can use this to see all the partner event sources that have been shared with your Amazon Web Services account.
-
#list_partner_event_source_accounts(params = {}) ⇒ Types::ListPartnerEventSourceAccountsResponse
An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with.
-
#list_partner_event_sources(params = {}) ⇒ Types::ListPartnerEventSourcesResponse
An SaaS partner can use this operation to list all the partner event source names that they have created.
-
#list_replays(params = {}) ⇒ Types::ListReplaysResponse
Lists your replays.
-
#list_rule_names_by_target(params = {}) ⇒ Types::ListRuleNamesByTargetResponse
Lists the rules for the specified target.
-
#list_rules(params = {}) ⇒ Types::ListRulesResponse
Lists your Amazon EventBridge rules.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Displays the tags associated with an EventBridge resource.
-
#list_targets_by_rule(params = {}) ⇒ Types::ListTargetsByRuleResponse
Lists the targets assigned to the specified rule.
-
#put_events(params = {}) ⇒ Types::PutEventsResponse
Sends custom events to Amazon EventBridge so that they can be matched to rules.
-
#put_partner_events(params = {}) ⇒ Types::PutPartnerEventsResponse
This is used by SaaS partners to write events to a customer's partner event bus.
-
#put_permission(params = {}) ⇒ Struct
Running
PutPermission
permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus. -
#put_rule(params = {}) ⇒ Types::PutRuleResponse
Creates or updates the specified rule.
-
#put_targets(params = {}) ⇒ Types::PutTargetsResponse
Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
-
#remove_permission(params = {}) ⇒ Struct
Revokes the permission of another Amazon Web Services account to be able to put events to the specified event bus.
-
#remove_targets(params = {}) ⇒ Types::RemoveTargetsResponse
Removes the specified targets from the specified rule.
-
#start_replay(params = {}) ⇒ Types::StartReplayResponse
Starts the specified replay.
-
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified EventBridge resource.
-
#test_event_pattern(params = {}) ⇒ Types::TestEventPatternResponse
Tests whether the specified event pattern matches the provided event.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified EventBridge resource.
-
#update_api_destination(params = {}) ⇒ Types::UpdateApiDestinationResponse
Updates an API destination.
-
#update_archive(params = {}) ⇒ Types::UpdateArchiveResponse
Updates the specified archive.
-
#update_connection(params = {}) ⇒ Types::UpdateConnectionResponse
Updates settings for a connection.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
419 420 421 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 419 def initialize(*args) super end |
Instance Method Details
#activate_event_source(params = {}) ⇒ Struct
Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.
444 445 446 447 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 444 def activate_event_source(params = {}, = {}) req = build_request(:activate_event_source, params) req.send_request() end |
#cancel_replay(params = {}) ⇒ Types::CancelReplayResponse
Cancels the specified replay.
476 477 478 479 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 476 def cancel_replay(params = {}, = {}) req = build_request(:cancel_replay, params) req.send_request() end |
#create_api_destination(params = {}) ⇒ Types::CreateApiDestinationResponse
Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.
534 535 536 537 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 534 def create_api_destination(params = {}, = {}) req = build_request(:create_api_destination, params) req.send_request() end |
#create_archive(params = {}) ⇒ Types::CreateArchiveResponse
Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive.
590 591 592 593 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 590 def create_archive(params = {}, = {}) req = build_request(:create_archive, params) req.send_request() end |
#create_connection(params = {}) ⇒ Types::CreateConnectionResponse
Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
702 703 704 705 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 702 def create_connection(params = {}, = {}) req = build_request(:create_connection, params) req.send_request() end |
#create_event_bus(params = {}) ⇒ Types::CreateEventBusResponse
Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source.
754 755 756 757 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 754 def create_event_bus(params = {}, = {}) req = build_request(:create_event_bus, params) req.send_request() end |
#create_partner_event_source(params = {}) ⇒ Types::CreatePartnerEventSourceResponse
Called by an SaaS partner to create a partner event source. This operation is not used by Amazon Web Services customers.
Each partner event source can be used by one Amazon Web Services account to create a matching partner event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each Amazon Web Services account that wants to receive those event types.
A partner event source creates events based on resources within the SaaS partner's service or application.
An Amazon Web Services account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using Amazon Web Services Events rules and targets.
Partner event source names follow this format:
partner_name/event_namespace/event_name
partner_name is determined during partner registration and identifies the partner to Amazon Web Services customers. event_namespace is determined by the partner and is a way for the partner to categorize their events. event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. The combination of event_namespace and event_name should help Amazon Web Services customers decide whether to create an event bus to receive these events.
819 820 821 822 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 819 def create_partner_event_source(params = {}, = {}) req = build_request(:create_partner_event_source, params) req.send_request() end |
#deactivate_event_source(params = {}) ⇒ Struct
You can use this operation to temporarily stop receiving events from the specified partner event source. The matching event bus is not deleted.
When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state for more than two weeks, it is deleted.
To activate a deactivated partner event source, use ActivateEventSource.
854 855 856 857 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 854 def deactivate_event_source(params = {}, = {}) req = build_request(:deactivate_event_source, params) req.send_request() end |
#deauthorize_connection(params = {}) ⇒ Types::DeauthorizeConnectionResponse
Removes all authorization parameters from the connection. This lets you remove the secret from the connection so you can reuse it without having to create a new connection.
892 893 894 895 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 892 def (params = {}, = {}) req = build_request(:deauthorize_connection, params) req.send_request() end |
#delete_api_destination(params = {}) ⇒ Struct
Deletes the specified API destination.
914 915 916 917 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 914 def delete_api_destination(params = {}, = {}) req = build_request(:delete_api_destination, params) req.send_request() end |
#delete_archive(params = {}) ⇒ Struct
Deletes the specified archive.
936 937 938 939 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 936 def delete_archive(params = {}, = {}) req = build_request(:delete_archive, params) req.send_request() end |
#delete_connection(params = {}) ⇒ Types::DeleteConnectionResponse
Deletes a connection.
972 973 974 975 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 972 def delete_connection(params = {}, = {}) req = build_request(:delete_connection, params) req.send_request() end |
#delete_event_bus(params = {}) ⇒ Struct
Deletes the specified custom event bus or partner event bus. All rules associated with this event bus need to be deleted. You can't delete your account's default event bus.
996 997 998 999 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 996 def delete_event_bus(params = {}, = {}) req = build_request(:delete_event_bus, params) req.send_request() end |
#delete_partner_event_source(params = {}) ⇒ Struct
This operation is used by SaaS partners to delete a partner event source. This operation is not used by Amazon Web Services customers.
When you delete an event source, the status of the corresponding partner event bus in the Amazon Web Services customer account becomes DELETED.
1028 1029 1030 1031 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 1028 def delete_partner_event_source(params = {}, = {}) req = build_request(:delete_partner_event_source, params) req.send_request() end |
#delete_rule(params = {}) ⇒ Struct
Deletes the specified rule.
Before you can delete the rule, you must remove all targets, using RemoveTargets.
When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect.
If you call delete rule multiple times for the same rule, all calls
will succeed. When you call delete rule for a non-existent custom
eventbus, ResourceNotFoundException
is returned.
Managed rules are rules created and managed by another Amazon Web
Services service on your behalf. These rules are created by those
other Amazon Web Services services to support functionality in those
services. You can delete these rules using the Force
option, but you
should do so only if you are sure the other service is not still using
that rule.
1084 1085 1086 1087 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 1084 def delete_rule(params = {}, = {}) req = build_request(:delete_rule, params) req.send_request() end |
#describe_api_destination(params = {}) ⇒ Types::DescribeApiDestinationResponse
Retrieves details about an API destination.
1130 1131 1132 1133 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 1130 def describe_api_destination(params = {}, = {}) req = build_request(:describe_api_destination, params) req.send_request() end |
#describe_archive(params = {}) ⇒ Types::DescribeArchiveResponse
Retrieves details about an archive.
1178 1179 1180 1181 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 1178 def describe_archive(params = {}, = {}) req = build_request(:describe_archive, params) req.send_request() end |
#describe_connection(params = {}) ⇒ Types::DescribeConnectionResponse
Retrieves details about a connection.
1254 1255 1256 1257 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 1254 def describe_connection(params = {}, = {}) req = build_request(:describe_connection, params) req.send_request() end |
#describe_event_bus(params = {}) ⇒ Types::DescribeEventBusResponse
Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time.
To enable your account to receive events from other accounts on its default event bus, use PutPermission.
For more information about partner event buses, see CreateEventBus.
1302 1303 1304 1305 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 1302 def describe_event_bus(params = {}, = {}) req = build_request(:describe_event_bus, params) req.send_request() end |
#describe_event_source(params = {}) ⇒ Types::DescribeEventSourceResponse
This operation lists details about a partner event source that is shared with your account.
1341 1342 1343 1344 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 1341 def describe_event_source(params = {}, = {}) req = build_request(:describe_event_source, params) req.send_request() end |
#describe_partner_event_source(params = {}) ⇒ Types::DescribePartnerEventSourceResponse
An SaaS partner can use this operation to list details about a partner event source that they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource to see details about a partner event source that is shared with them.
1379 1380 1381 1382 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 1379 def describe_partner_event_source(params = {}, = {}) req = build_request(:describe_partner_event_source, params) req.send_request() end |
#describe_replay(params = {}) ⇒ Types::DescribeReplayResponse
Retrieves details about a replay. Use DescribeReplay
to determine
the progress of a running replay. A replay processes events to replay
based on the time in the event, and replays them using 1 minute
intervals. If you use StartReplay
and specify an EventStartTime
and an EventEndTime
that covers a 20 minute time range, the events
are replayed from the first minute of that 20 minute range first. Then
the events from the second minute are replayed. You can use
DescribeReplay
to determine the progress of a replay. The value
returned for EventLastReplayedTime
indicates the time within the
specified time range associated with the last event replayed.
1440 1441 1442 1443 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 1440 def describe_replay(params = {}, = {}) req = build_request(:describe_replay, params) req.send_request() end |
#describe_rule(params = {}) ⇒ Types::DescribeRuleResponse
Describes the specified rule.
DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
1498 1499 1500 1501 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 1498 def describe_rule(params = {}, = {}) req = build_request(:describe_rule, params) req.send_request() end |
#disable_rule(params = {}) ⇒ Struct
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. Allow a short period of time for changes to take effect.
1530 1531 1532 1533 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 1530 def disable_rule(params = {}, = {}) req = build_request(:disable_rule, params) req.send_request() end |
#enable_rule(params = {}) ⇒ Struct
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. Allow a short period of time for changes to take effect.
1562 1563 1564 1565 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 1562 def enable_rule(params = {}, = {}) req = build_request(:enable_rule, params) req.send_request() end |
#list_api_destinations(params = {}) ⇒ Types::ListApiDestinationsResponse
Retrieves a list of API destination in the account in the current Region.
1616 1617 1618 1619 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 1616 def list_api_destinations(params = {}, = {}) req = build_request(:list_api_destinations, params) req.send_request() end |
#list_archives(params = {}) ⇒ Types::ListArchivesResponse
Lists your archives. You can either list all the archives or you can provide a prefix to match to the archive names. Filter parameters are exclusive.
1674 1675 1676 1677 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 1674 def list_archives(params = {}, = {}) req = build_request(:list_archives, params) req.send_request() end |
#list_connections(params = {}) ⇒ Types::ListConnectionsResponse
Retrieves a list of connections from the account.
1726 1727 1728 1729 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 1726 def list_connections(params = {}, = {}) req = build_request(:list_connections, params) req.send_request() end |
#list_event_buses(params = {}) ⇒ Types::ListEventBusesResponse
Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.
1772 1773 1774 1775 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 1772 def list_event_buses(params = {}, = {}) req = build_request(:list_event_buses, params) req.send_request() end |
#list_event_sources(params = {}) ⇒ Types::ListEventSourcesResponse
You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sources, see CreateEventBus.
1826 1827 1828 1829 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 1826 def list_event_sources(params = {}, = {}) req = build_request(:list_event_sources, params) req.send_request() end |
#list_partner_event_source_accounts(params = {}) ⇒ Types::ListPartnerEventSourceAccountsResponse
An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with. This operation is not used by Amazon Web Services customers.
1875 1876 1877 1878 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 1875 def list_partner_event_source_accounts(params = {}, = {}) req = build_request(:list_partner_event_source_accounts, params) req.send_request() end |
#list_partner_event_sources(params = {}) ⇒ Types::ListPartnerEventSourcesResponse
An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by Amazon Web Services customers.
1921 1922 1923 1924 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 1921 def list_partner_event_sources(params = {}, = {}) req = build_request(:list_partner_event_sources, params) req.send_request() end |
#list_replays(params = {}) ⇒ Types::ListReplaysResponse
Lists your replays. You can either list all the replays or you can provide a prefix to match to the replay names. Filter parameters are exclusive.
1980 1981 1982 1983 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 1980 def list_replays(params = {}, = {}) req = build_request(:list_replays, params) req.send_request() end |
#list_rule_names_by_target(params = {}) ⇒ Types::ListRuleNamesByTargetResponse
Lists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a specific target in your account.
2027 2028 2029 2030 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 2027 def list_rule_names_by_target(params = {}, = {}) req = build_request(:list_rule_names_by_target, params) req.send_request() end |
#list_rules(params = {}) ⇒ Types::ListRulesResponse
Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names.
ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
2088 2089 2090 2091 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 2088 def list_rules(params = {}, = {}) req = build_request(:list_rules, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.
2119 2120 2121 2122 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 2119 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_targets_by_rule(params = {}) ⇒ Types::ListTargetsByRuleResponse
Lists the targets assigned to the specified rule.
2226 2227 2228 2229 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 2226 def list_targets_by_rule(params = {}, = {}) req = build_request(:list_targets_by_rule, params) req.send_request() end |
#put_events(params = {}) ⇒ Types::PutEventsResponse
Sends custom events to Amazon EventBridge so that they can be matched to rules.
2272 2273 2274 2275 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 2272 def put_events(params = {}, = {}) req = build_request(:put_events, params) req.send_request() end |
#put_partner_events(params = {}) ⇒ Types::PutPartnerEventsResponse
This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation.
2314 2315 2316 2317 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 2314 def put_partner_events(params = {}, = {}) req = build_request(:put_partner_events, params) req.send_request() end |
#put_permission(params = {}) ⇒ Struct
Running PutPermission
permits the specified Amazon Web Services
account or Amazon Web Services organization to put events to the
specified event bus. Amazon EventBridge (CloudWatch Events) rules in
your account are triggered by these events arriving to an event bus in
your account.
For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target.
To enable multiple Amazon Web Services accounts to put events to your
event bus, run PutPermission
once for each of these accounts. Or, if
all the accounts are members of the same Amazon Web Services
organization, you can run PutPermission
once specifying Principal
as "*" and specifying the Amazon Web Services organization ID in
Condition
, to grant permissions to all accounts in that
organization.
If you grant permissions using an organization, then accounts in that
organization must specify a RoleArn
with proper permissions when
they use PutTarget
to add your account's event bus as a target. For
more information, see Sending and Receiving Events Between Amazon Web
Services Accounts in the Amazon EventBridge User Guide.
The permission policy on the event bus cannot exceed 10 KB in size.
2423 2424 2425 2426 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 2423 def (params = {}, = {}) req = build_request(:put_permission, params) req.send_request() end |
#put_rule(params = {}) ⇒ Types::PutRuleResponse
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.
A single rule watches for events from a single event bus. Events generated by Amazon Web Services services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus.
If you are updating an existing rule, the rule is replaced with what
you specify in this PutRule
command. If you omit arguments in
PutRule
, the old values for those arguments are not kept. Instead,
they are replaced with null values.
When you create or update a rule, incoming events might not immediately start matching to new or updated rules. 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.
When you initially create a rule, you can optionally assign one or
more tags to the rule. Tags can help you organize and categorize your
resources. You can also use them to scope user permissions, by
granting a user permission to access or change only rules with certain
tag values. To use the PutRule
operation and assign tags, you must
have both the events:PutRule
and events:TagResource
permissions.
If you are updating an existing rule, any tags you specify in the
PutRule
operation are ignored. To update the tags of an existing
rule, use TagResource and UntagResource.
Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge 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.
In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.
To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.
An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets.
2565 2566 2567 2568 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 2565 def put_rule(params = {}, = {}) req = build_request(:put_rule, params) req.send_request() end |
#put_targets(params = {}) ⇒ Types::PutTargetsResponse
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 Events:
Amazon API Gateway REST API endpoints
API Gateway
Batch job queue
CloudWatch Logs group
CodeBuild project
CodePipeline
Amazon EC2
CreateSnapshot
API callAmazon EC2
RebootInstances
API callAmazon EC2
StopInstances
API callAmazon EC2
TerminateInstances
API callAmazon ECS tasks
Event bus in a different Amazon Web Services account or Region.
You can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule.
Firehose delivery stream (Kinesis Data Firehose)
Inspector assessment template (Amazon Inspector)
Kinesis stream (Kinesis Data Stream)
Lambda function
Redshift clusters (Data API statement execution)
Amazon SNS topic
Amazon SQS queues (includes FIFO queues
SSM Automation
SSM OpsItem
SSM Run Command
Step Functions state machines
Creating rules with built-in targets is supported only in the Amazon
Web Services Management Console. The built-in targets are EC2
CreateSnapshot API call
, EC2 RebootInstances API call
, EC2
StopInstances API call
, and EC2 TerminateInstances API call
.
For some target types, PutTargets
provides target-specific
parameters. If the target is a Kinesis data 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 EventBridge needs the appropriate permissions. For Lambda and
Amazon SNS resources, EventBridge relies on resource-based policies.
For EC2 instances, Kinesis Data Streams, Step Functions state machines
and API Gateway REST APIs, EventBridge relies on IAM roles that you
specify in the RoleARN
argument in PutTargets
. For more
information, see Authentication and Access Control in the Amazon
EventBridge User Guide.
If another Amazon Web Services account is in the same region and has
granted you permission (using PutPermission
), you can send events to
that account. Set 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
value when you run
PutTargets
. If your account sends events to another account, your
account is charged for each sent event. Each event sent to another
account is charged as a custom event. The account receiving the event
is not charged. For more information, see Amazon EventBridge
Pricing.
Input
, InputPath
, and InputTransformer
are not available with
PutTarget
if the target is an event bus of a different Amazon Web
Services account.
If you are setting the event bus of another account as the target, and
that account granted permission to your account through an
organization instead of directly by the account ID, then you must
specify a RoleArn
with proper permissions in the Target
structure.
For more information, see Sending and Receiving Events Between Amazon
Web Services Accounts in the Amazon EventBridge User Guide.
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 format (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 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. 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.
2865 2866 2867 2868 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 2865 def put_targets(params = {}, = {}) req = build_request(:put_targets, params) req.send_request() end |
#remove_permission(params = {}) ⇒ Struct
Revokes the permission of another Amazon Web Services account to be
able to put events to the specified 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.
2905 2906 2907 2908 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 2905 def (params = {}, = {}) req = build_request(:remove_permission, params) req.send_request() end |
#remove_targets(params = {}) ⇒ Types::RemoveTargetsResponse
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. 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.
2965 2966 2967 2968 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 2965 def remove_targets(params = {}, = {}) req = build_request(:remove_targets, params) req.send_request() end |
#start_replay(params = {}) ⇒ Types::StartReplayResponse
Starts the specified replay. Events are not necessarily replayed in
the exact same order that they were added to the archive. A replay
processes events to replay based on the time in the event, and replays
them using 1 minute intervals. If you specify an EventStartTime
and
an EventEndTime
that covers a 20 minute time range, the events are
replayed from the first minute of that 20 minute range first. Then the
events from the second minute are replayed. You can use
DescribeReplay
to determine the progress of a replay. The value
returned for EventLastReplayedTime
indicates the time within the
specified time range associated with the last event replayed.
3034 3035 3036 3037 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 3034 def start_replay(params = {}, = {}) req = build_request(:start_replay, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules and event buses can be tagged.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource
action with a resource that already has
tags. If you specify a new tag key, this tag is appended to the list
of tags associated with the resource. If you specify a tag key that is
already associated with the resource, the new tag value that you
specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.
3080 3081 3082 3083 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 3080 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#test_event_pattern(params = {}) ⇒ Types::TestEventPatternResponse
Tests whether the specified event pattern matches the provided event.
Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge 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.
3143 3144 3145 3146 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 3143 def test_event_pattern(params = {}, = {}) req = build_request(:test_event_pattern, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events), rules and event buses can be tagged.
3171 3172 3173 3174 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 3171 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_api_destination(params = {}) ⇒ Types::UpdateApiDestinationResponse
Updates an API destination.
3226 3227 3228 3229 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 3226 def update_api_destination(params = {}, = {}) req = build_request(:update_api_destination, params) req.send_request() end |
#update_archive(params = {}) ⇒ Types::UpdateArchiveResponse
Updates the specified archive.
3272 3273 3274 3275 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 3272 def update_archive(params = {}, = {}) req = build_request(:update_archive, params) req.send_request() end |
#update_connection(params = {}) ⇒ Types::UpdateConnectionResponse
Updates settings for a connection.
3383 3384 3385 3386 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 3383 def update_connection(params = {}, = {}) req = build_request(:update_connection, params) req.send_request() end |