aws-sdk-cloudwatchevents 1.49.0 → 1.53.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudwatchevents/client.rb +210 -143
- data/lib/aws-sdk-cloudwatchevents/types.rb +148 -118
- data/lib/aws-sdk-cloudwatchevents.rb +1 -1
- metadata +5 -5
@@ -285,6 +285,15 @@ module Aws::CloudWatchEvents
|
|
285
285
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
286
286
|
# requests are made, and retries are disabled.
|
287
287
|
#
|
288
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
289
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
290
|
+
# will be used if available.
|
291
|
+
#
|
292
|
+
# @option options [Boolean] :use_fips_endpoint
|
293
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
294
|
+
# When a `fips` region is used, the region is normalized and this config
|
295
|
+
# is set to `true`.
|
296
|
+
#
|
288
297
|
# @option options [Boolean] :validate_params (true)
|
289
298
|
# When `true`, request parameters are validated before
|
290
299
|
# sending the request.
|
@@ -462,7 +471,7 @@ module Aws::CloudWatchEvents
|
|
462
471
|
# The name for the archive to create.
|
463
472
|
#
|
464
473
|
# @option params [required, String] :event_source_arn
|
465
|
-
# The ARN of the event
|
474
|
+
# The ARN of the event bus that sends events to the archive.
|
466
475
|
#
|
467
476
|
# @option params [String] :description
|
468
477
|
# A description for the archive.
|
@@ -672,43 +681,45 @@ module Aws::CloudWatchEvents
|
|
672
681
|
end
|
673
682
|
|
674
683
|
# Called by an SaaS partner to create a partner event source. This
|
675
|
-
# operation is not used by
|
684
|
+
# operation is not used by Amazon Web Services customers.
|
676
685
|
#
|
677
|
-
# Each partner event source can be used by one
|
678
|
-
# matching partner event bus in that
|
679
|
-
#
|
680
|
-
# receive those event
|
686
|
+
# Each partner event source can be used by one Amazon Web Services
|
687
|
+
# account to create a matching partner event bus in that Amazon Web
|
688
|
+
# Services account. A SaaS partner must create one partner event source
|
689
|
+
# for each Amazon Web Services account that wants to receive those event
|
690
|
+
# types.
|
681
691
|
#
|
682
692
|
# A partner event source creates events based on resources within the
|
683
693
|
# SaaS partner's service or application.
|
684
694
|
#
|
685
|
-
# An
|
686
|
-
# partner event source can use that event bus to receive
|
687
|
-
# partner, and then process them using
|
695
|
+
# An Amazon Web Services account that creates a partner event bus that
|
696
|
+
# matches the partner event source can use that event bus to receive
|
697
|
+
# events from the partner, and then process them using Amazon Web
|
698
|
+
# Services Events rules and targets.
|
688
699
|
#
|
689
700
|
# Partner event source names follow this format:
|
690
701
|
#
|
691
702
|
# ` partner_name/event_namespace/event_name `
|
692
703
|
#
|
693
704
|
# *partner\_name* is determined during partner registration and
|
694
|
-
# identifies the partner to
|
695
|
-
# determined by the partner and is a way for the
|
696
|
-
# their events. *event\_name* is determined by the
|
697
|
-
# uniquely identify an event-generating resource
|
698
|
-
# system. The combination of *event\_namespace* and
|
699
|
-
# help
|
700
|
-
# these events.
|
705
|
+
# identifies the partner to Amazon Web Services customers.
|
706
|
+
# *event\_namespace* is determined by the partner and is a way for the
|
707
|
+
# partner to categorize their events. *event\_name* is determined by the
|
708
|
+
# partner, and should uniquely identify an event-generating resource
|
709
|
+
# within the partner system. The combination of *event\_namespace* and
|
710
|
+
# *event\_name* should help Amazon Web Services customers decide whether
|
711
|
+
# to create an event bus to receive these events.
|
701
712
|
#
|
702
713
|
# @option params [required, String] :name
|
703
714
|
# The name of the partner event source. This name must be unique and
|
704
715
|
# must be in the format ` partner_name/event_namespace/event_name `. The
|
705
|
-
#
|
706
|
-
# partner event bus with a name that matches the
|
707
|
-
# event source.
|
716
|
+
# Amazon Web Services account that wants to use this partner event
|
717
|
+
# source must create a partner event bus with a name that matches the
|
718
|
+
# name of the partner event source.
|
708
719
|
#
|
709
720
|
# @option params [required, String] :account
|
710
|
-
# The
|
711
|
-
# event bus for this partner event source.
|
721
|
+
# The Amazon Web Services account ID that is permitted to create a
|
722
|
+
# matching partner event bus for this partner event source.
|
712
723
|
#
|
713
724
|
# @return [Types::CreatePartnerEventSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
714
725
|
#
|
@@ -743,7 +754,11 @@ module Aws::CloudWatchEvents
|
|
743
754
|
# it is deleted.
|
744
755
|
#
|
745
756
|
# To activate a deactivated partner event source, use
|
746
|
-
# ActivateEventSource.
|
757
|
+
# [ActivateEventSource][1].
|
758
|
+
#
|
759
|
+
#
|
760
|
+
#
|
761
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ActivateEventSource.html
|
747
762
|
#
|
748
763
|
# @option params [required, String] :name
|
749
764
|
# The name of the partner event source to deactivate.
|
@@ -908,17 +923,18 @@ module Aws::CloudWatchEvents
|
|
908
923
|
end
|
909
924
|
|
910
925
|
# This operation is used by SaaS partners to delete a partner event
|
911
|
-
# source. This operation is not used by
|
926
|
+
# source. This operation is not used by Amazon Web Services customers.
|
912
927
|
#
|
913
928
|
# When you delete an event source, the status of the corresponding
|
914
|
-
# partner event bus in the
|
929
|
+
# partner event bus in the Amazon Web Services customer account becomes
|
930
|
+
# DELETED.
|
915
931
|
#
|
916
932
|
# @option params [required, String] :name
|
917
933
|
# The name of the event source to delete.
|
918
934
|
#
|
919
935
|
# @option params [required, String] :account
|
920
|
-
# The
|
921
|
-
# created for.
|
936
|
+
# The Amazon Web Services account ID of the Amazon Web Services customer
|
937
|
+
# that the event source was created for.
|
922
938
|
#
|
923
939
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
924
940
|
#
|
@@ -941,7 +957,7 @@ module Aws::CloudWatchEvents
|
|
941
957
|
# Deletes the specified rule.
|
942
958
|
#
|
943
959
|
# Before you can delete the rule, you must remove all targets, using
|
944
|
-
# RemoveTargets.
|
960
|
+
# [RemoveTargets][1].
|
945
961
|
#
|
946
962
|
# When you delete a rule, incoming events might continue to match to the
|
947
963
|
# deleted rule. Allow a short period of time for changes to take effect.
|
@@ -950,11 +966,16 @@ module Aws::CloudWatchEvents
|
|
950
966
|
# will succeed. When you call delete rule for a non-existent custom
|
951
967
|
# eventbus, `ResourceNotFoundException` is returned.
|
952
968
|
#
|
953
|
-
# Managed rules are rules created and managed by another
|
954
|
-
# your behalf. These rules are created by those
|
955
|
-
#
|
956
|
-
# using the `Force` option, but you
|
957
|
-
# the other service is not still using
|
969
|
+
# Managed rules are rules created and managed by another Amazon Web
|
970
|
+
# Services service on your behalf. These rules are created by those
|
971
|
+
# other Amazon Web Services services to support functionality in those
|
972
|
+
# services. You can delete these rules using the `Force` option, but you
|
973
|
+
# should do so only if you are sure the other service is not still using
|
974
|
+
# that rule.
|
975
|
+
#
|
976
|
+
#
|
977
|
+
#
|
978
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemoveTargets.html
|
958
979
|
#
|
959
980
|
# @option params [required, String] :name
|
960
981
|
# The name of the rule.
|
@@ -964,11 +985,11 @@ module Aws::CloudWatchEvents
|
|
964
985
|
# this, the default event bus is used.
|
965
986
|
#
|
966
987
|
# @option params [Boolean] :force
|
967
|
-
# If this is a managed rule, created by an
|
968
|
-
# you must specify `Force` as `True` to delete the rule.
|
969
|
-
# is ignored for rules that are not managed rules. You
|
970
|
-
# a rule is a managed rule by using `DescribeRule` or
|
971
|
-
# checking the `ManagedBy` field of the response.
|
988
|
+
# If this is a managed rule, created by an Amazon Web Services service
|
989
|
+
# on your behalf, you must specify `Force` as `True` to delete the rule.
|
990
|
+
# This parameter is ignored for rules that are not managed rules. You
|
991
|
+
# can check whether a rule is a managed rule by using `DescribeRule` or
|
992
|
+
# `ListRules` and checking the `ManagedBy` field of the response.
|
972
993
|
#
|
973
994
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
974
995
|
#
|
@@ -1160,15 +1181,21 @@ module Aws::CloudWatchEvents
|
|
1160
1181
|
end
|
1161
1182
|
|
1162
1183
|
# Displays details about an event bus in your account. This can include
|
1163
|
-
# the external
|
1164
|
-
# default event bus, and the associated policy. For
|
1165
|
-
# and partner event buses, it displays the name, ARN,
|
1166
|
-
# creation time.
|
1184
|
+
# the external Amazon Web Services accounts that are permitted to write
|
1185
|
+
# events to your default event bus, and the associated policy. For
|
1186
|
+
# custom event buses and partner event buses, it displays the name, ARN,
|
1187
|
+
# policy, state, and creation time.
|
1167
1188
|
#
|
1168
1189
|
# To enable your account to receive events from other accounts on its
|
1169
|
-
# default event bus, use PutPermission.
|
1190
|
+
# default event bus, use [PutPermission][1].
|
1191
|
+
#
|
1192
|
+
# For more information about partner event buses, see
|
1193
|
+
# [CreateEventBus][2].
|
1194
|
+
#
|
1195
|
+
#
|
1170
1196
|
#
|
1171
|
-
#
|
1197
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html
|
1198
|
+
# [2]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html
|
1172
1199
|
#
|
1173
1200
|
# @option params [String] :name
|
1174
1201
|
# The name or ARN of the event bus to show details for. If you omit
|
@@ -1241,9 +1268,14 @@ module Aws::CloudWatchEvents
|
|
1241
1268
|
end
|
1242
1269
|
|
1243
1270
|
# An SaaS partner can use this operation to list details about a partner
|
1244
|
-
# event source that they have created.
|
1245
|
-
# operation. Instead,
|
1246
|
-
# details about a partner event source
|
1271
|
+
# event source that they have created. Amazon Web Services customers do
|
1272
|
+
# not use this operation. Instead, Amazon Web Services customers can use
|
1273
|
+
# [DescribeEventSource][1] to see details about a partner event source
|
1274
|
+
# that is shared with them.
|
1275
|
+
#
|
1276
|
+
#
|
1277
|
+
#
|
1278
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventSource.html
|
1247
1279
|
#
|
1248
1280
|
# @option params [required, String] :name
|
1249
1281
|
# The name of the event source to display.
|
@@ -1337,7 +1369,11 @@ module Aws::CloudWatchEvents
|
|
1337
1369
|
# Describes the specified rule.
|
1338
1370
|
#
|
1339
1371
|
# DescribeRule does not list the targets of a rule. To see the targets
|
1340
|
-
# associated with a rule, use ListTargetsByRule.
|
1372
|
+
# associated with a rule, use [ListTargetsByRule][1].
|
1373
|
+
#
|
1374
|
+
#
|
1375
|
+
#
|
1376
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html
|
1341
1377
|
#
|
1342
1378
|
# @option params [required, String] :name
|
1343
1379
|
# The name of the rule.
|
@@ -1663,8 +1699,12 @@ module Aws::CloudWatchEvents
|
|
1663
1699
|
end
|
1664
1700
|
|
1665
1701
|
# You can use this to see all the partner event sources that have been
|
1666
|
-
# shared with your
|
1667
|
-
# sources, see CreateEventBus.
|
1702
|
+
# shared with your Amazon Web Services account. For more information
|
1703
|
+
# about partner event sources, see [CreateEventBus][1].
|
1704
|
+
#
|
1705
|
+
#
|
1706
|
+
#
|
1707
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html
|
1668
1708
|
#
|
1669
1709
|
# @option params [String] :name_prefix
|
1670
1710
|
# Specifying this limits the results to only those partner event sources
|
@@ -1712,9 +1752,10 @@ module Aws::CloudWatchEvents
|
|
1712
1752
|
req.send_request(options)
|
1713
1753
|
end
|
1714
1754
|
|
1715
|
-
# An SaaS partner can use this operation to display the
|
1716
|
-
# that a particular partner event source name is
|
1717
|
-
# operation is not used by
|
1755
|
+
# An SaaS partner can use this operation to display the Amazon Web
|
1756
|
+
# Services account ID that a particular partner event source name is
|
1757
|
+
# associated with. This operation is not used by Amazon Web Services
|
1758
|
+
# customers.
|
1718
1759
|
#
|
1719
1760
|
# @option params [required, String] :event_source_name
|
1720
1761
|
# The name of the partner event source to display account information
|
@@ -1761,8 +1802,8 @@ module Aws::CloudWatchEvents
|
|
1761
1802
|
end
|
1762
1803
|
|
1763
1804
|
# An SaaS partner can use this operation to list all the partner event
|
1764
|
-
# source names that they have created. This operation is not used by
|
1765
|
-
# customers.
|
1805
|
+
# source names that they have created. This operation is not used by
|
1806
|
+
# Amazon Web Services customers.
|
1766
1807
|
#
|
1767
1808
|
# @option params [required, String] :name_prefix
|
1768
1809
|
# If you specify this, the results are limited to only those partner
|
@@ -1818,7 +1859,7 @@ module Aws::CloudWatchEvents
|
|
1818
1859
|
# The state of the replay.
|
1819
1860
|
#
|
1820
1861
|
# @option params [String] :event_source_arn
|
1821
|
-
# The ARN of the
|
1862
|
+
# The ARN of the archive from which the events are replayed.
|
1822
1863
|
#
|
1823
1864
|
# @option params [String] :next_token
|
1824
1865
|
# The token returned by a previous call to retrieve the next set of
|
@@ -1916,7 +1957,11 @@ module Aws::CloudWatchEvents
|
|
1916
1957
|
# or you can provide a prefix to match to the rule names.
|
1917
1958
|
#
|
1918
1959
|
# ListRules does not list the targets of a rule. To see the targets
|
1919
|
-
# associated with a rule, use ListTargetsByRule.
|
1960
|
+
# associated with a rule, use [ListTargetsByRule][1].
|
1961
|
+
#
|
1962
|
+
#
|
1963
|
+
#
|
1964
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html
|
1920
1965
|
#
|
1921
1966
|
# @option params [String] :name_prefix
|
1922
1967
|
# The prefix matching the rule name.
|
@@ -2048,7 +2093,7 @@ module Aws::CloudWatchEvents
|
|
2048
2093
|
# resp.targets[0].run_command_parameters.run_command_targets[0].values[0] #=> String
|
2049
2094
|
# resp.targets[0].ecs_parameters.task_definition_arn #=> String
|
2050
2095
|
# resp.targets[0].ecs_parameters.task_count #=> Integer
|
2051
|
-
# resp.targets[0].ecs_parameters.launch_type #=> String, one of "EC2", "FARGATE"
|
2096
|
+
# resp.targets[0].ecs_parameters.launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
|
2052
2097
|
# resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.subnets #=> Array
|
2053
2098
|
# resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.subnets[0] #=> String
|
2054
2099
|
# resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.security_groups #=> Array
|
@@ -2154,7 +2199,7 @@ module Aws::CloudWatchEvents
|
|
2154
2199
|
end
|
2155
2200
|
|
2156
2201
|
# This is used by SaaS partners to write events to a customer's partner
|
2157
|
-
# event bus.
|
2202
|
+
# event bus. Amazon Web Services customers do not use this operation.
|
2158
2203
|
#
|
2159
2204
|
# @option params [required, Array<Types::PutPartnerEventsRequestEntry>] :entries
|
2160
2205
|
# The list of events to write to the event bus.
|
@@ -2195,30 +2240,31 @@ module Aws::CloudWatchEvents
|
|
2195
2240
|
req.send_request(options)
|
2196
2241
|
end
|
2197
2242
|
|
2198
|
-
# Running `PutPermission` permits the specified
|
2199
|
-
# organization to put events to the
|
2200
|
-
# EventBridge (CloudWatch Events) rules in
|
2201
|
-
# these events arriving to an event bus in
|
2243
|
+
# Running `PutPermission` permits the specified Amazon Web Services
|
2244
|
+
# account or Amazon Web Services organization to put events to the
|
2245
|
+
# specified *event bus*. Amazon EventBridge (CloudWatch Events) rules in
|
2246
|
+
# your account are triggered by these events arriving to an event bus in
|
2247
|
+
# your account.
|
2202
2248
|
#
|
2203
2249
|
# For another account to send events to your account, that external
|
2204
2250
|
# account must have an EventBridge rule with your account's event bus
|
2205
2251
|
# as a target.
|
2206
2252
|
#
|
2207
|
-
# To enable multiple
|
2208
|
-
# `PutPermission` once for each of these accounts. Or, if
|
2209
|
-
# accounts are members of the same
|
2210
|
-
# `PutPermission` once specifying `Principal`
|
2211
|
-
#
|
2212
|
-
# accounts in that
|
2253
|
+
# To enable multiple Amazon Web Services accounts to put events to your
|
2254
|
+
# event bus, run `PutPermission` once for each of these accounts. Or, if
|
2255
|
+
# all the accounts are members of the same Amazon Web Services
|
2256
|
+
# organization, you can run `PutPermission` once specifying `Principal`
|
2257
|
+
# as "*" and specifying the Amazon Web Services organization ID in
|
2258
|
+
# `Condition`, to grant permissions to all accounts in that
|
2259
|
+
# organization.
|
2213
2260
|
#
|
2214
2261
|
# If you grant permissions using an organization, then accounts in that
|
2215
2262
|
# organization must specify a `RoleArn` with proper permissions when
|
2216
2263
|
# they use `PutTarget` to add your account's event bus as a target. For
|
2217
|
-
# more information, see [Sending and Receiving Events Between
|
2218
|
-
# Accounts][1] in the *Amazon EventBridge User Guide*.
|
2264
|
+
# more information, see [Sending and Receiving Events Between Amazon Web
|
2265
|
+
# Services Accounts][1] in the *Amazon EventBridge User Guide*.
|
2219
2266
|
#
|
2220
|
-
# The permission policy on the
|
2221
|
-
# size.
|
2267
|
+
# The permission policy on the event bus cannot exceed 10 KB in size.
|
2222
2268
|
#
|
2223
2269
|
#
|
2224
2270
|
#
|
@@ -2230,12 +2276,11 @@ module Aws::CloudWatchEvents
|
|
2230
2276
|
#
|
2231
2277
|
# @option params [String] :action
|
2232
2278
|
# The action that you are enabling the other account to perform.
|
2233
|
-
# Currently, this must be `events:PutEvents`.
|
2234
2279
|
#
|
2235
2280
|
# @option params [String] :principal
|
2236
|
-
# The 12-digit
|
2237
|
-
# your default event bus. Specify "*" to permit any
|
2238
|
-
# events to your default event bus.
|
2281
|
+
# The 12-digit Amazon Web Services account ID that you are permitting to
|
2282
|
+
# put events to your default event bus. Specify "*" to permit any
|
2283
|
+
# account to put events to your default event bus.
|
2239
2284
|
#
|
2240
2285
|
# If you specify "*" without specifying `Condition`, avoid creating
|
2241
2286
|
# rules that may match undesirable events. To create more secure rules,
|
@@ -2248,17 +2293,23 @@ module Aws::CloudWatchEvents
|
|
2248
2293
|
# An identifier string for the external account that you are granting
|
2249
2294
|
# permissions to. If you later want to revoke the permission for this
|
2250
2295
|
# external account, specify this `StatementId` when you run
|
2251
|
-
# RemovePermission.
|
2296
|
+
# [RemovePermission][1].
|
2297
|
+
#
|
2298
|
+
#
|
2299
|
+
#
|
2300
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html
|
2252
2301
|
#
|
2253
2302
|
# @option params [Types::Condition] :condition
|
2254
2303
|
# This parameter enables you to limit the permission to accounts that
|
2255
|
-
# fulfill a certain condition, such as being a member of a certain
|
2256
|
-
# organization. For more information about
|
2257
|
-
#
|
2304
|
+
# fulfill a certain condition, such as being a member of a certain
|
2305
|
+
# Amazon Web Services organization. For more information about Amazon
|
2306
|
+
# Web Services Organizations, see [What Is Amazon Web Services
|
2307
|
+
# Organizations][1] in the *Amazon Web Services Organizations User
|
2308
|
+
# Guide*.
|
2258
2309
|
#
|
2259
|
-
# If you specify `Condition` with an
|
2260
|
-
# "*" as the value for `Principal`, you grant
|
2261
|
-
# accounts in the named organization.
|
2310
|
+
# If you specify `Condition` with an Amazon Web Services organization
|
2311
|
+
# ID, and specify "*" as the value for `Principal`, you grant
|
2312
|
+
# permission to all the accounts in the named organization.
|
2262
2313
|
#
|
2263
2314
|
# The `Condition` is a JSON string which must contain `Type`, `Key`, and
|
2264
2315
|
# `Value` fields.
|
@@ -2300,15 +2351,15 @@ module Aws::CloudWatchEvents
|
|
2300
2351
|
|
2301
2352
|
# Creates or updates the specified rule. Rules are enabled by default,
|
2302
2353
|
# or based on value of the state. You can disable a rule using
|
2303
|
-
# DisableRule.
|
2354
|
+
# [DisableRule][1].
|
2304
2355
|
#
|
2305
2356
|
# A single rule watches for events from a single event bus. Events
|
2306
|
-
# generated by
|
2307
|
-
# Events generated by SaaS partner services or
|
2308
|
-
# matching partner event bus. If you have custom
|
2309
|
-
# services, you can specify whether their events go to
|
2310
|
-
# event bus or a custom event bus that you have created.
|
2311
|
-
# information, see CreateEventBus.
|
2357
|
+
# generated by Amazon Web Services services go to your account's
|
2358
|
+
# default event bus. Events generated by SaaS partner services or
|
2359
|
+
# applications go to the matching partner event bus. If you have custom
|
2360
|
+
# applications or services, you can specify whether their events go to
|
2361
|
+
# your default event bus or a custom event bus that you have created.
|
2362
|
+
# For more information, see [CreateEventBus][2].
|
2312
2363
|
#
|
2313
2364
|
# If you are updating an existing rule, the rule is replaced with what
|
2314
2365
|
# you specify in this `PutRule` command. If you omit arguments in
|
@@ -2335,13 +2386,13 @@ module Aws::CloudWatchEvents
|
|
2335
2386
|
#
|
2336
2387
|
# If you are updating an existing rule, any tags you specify in the
|
2337
2388
|
# `PutRule` operation are ignored. To update the tags of an existing
|
2338
|
-
# rule, use TagResource and UntagResource.
|
2389
|
+
# rule, use [TagResource][3] and [UntagResource][4].
|
2339
2390
|
#
|
2340
|
-
# Most services in
|
2341
|
-
# Resource Names (ARNs). However, EventBridge uses
|
2342
|
-
# event patterns and rules. Be sure to use the correct
|
2343
|
-
# when creating event patterns so that they match the ARN
|
2344
|
-
# event you want to match.
|
2391
|
+
# Most services in Amazon Web Services treat : or / as the same
|
2392
|
+
# character in Amazon Resource Names (ARNs). However, EventBridge uses
|
2393
|
+
# an exact match in event patterns and rules. Be sure to use the correct
|
2394
|
+
# ARN characters when creating event patterns so that they match the ARN
|
2395
|
+
# syntax in the event you want to match.
|
2345
2396
|
#
|
2346
2397
|
# In EventBridge, it is possible to create rules that lead to infinite
|
2347
2398
|
# loops, where a rule is fired repeatedly. For example, a rule might
|
@@ -2357,11 +2408,15 @@ module Aws::CloudWatchEvents
|
|
2357
2408
|
# An infinite loop can quickly cause higher than expected charges. We
|
2358
2409
|
# recommend that you use budgeting, which alerts you when charges exceed
|
2359
2410
|
# your specified limit. For more information, see [Managing Your Costs
|
2360
|
-
# with Budgets][
|
2411
|
+
# with Budgets][5].
|
2361
2412
|
#
|
2362
2413
|
#
|
2363
2414
|
#
|
2364
|
-
# [1]: https://docs.aws.amazon.com/
|
2415
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html
|
2416
|
+
# [2]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html
|
2417
|
+
# [3]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_TagResource.html
|
2418
|
+
# [4]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UntagResource.html
|
2419
|
+
# [5]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html
|
2365
2420
|
#
|
2366
2421
|
# @option params [required, String] :name
|
2367
2422
|
# The name of the rule that you are creating or updating.
|
@@ -2388,6 +2443,12 @@ module Aws::CloudWatchEvents
|
|
2388
2443
|
# The Amazon Resource Name (ARN) of the IAM role associated with the
|
2389
2444
|
# rule.
|
2390
2445
|
#
|
2446
|
+
# If you're setting an event bus in another account as the target and
|
2447
|
+
# that account granted permission to your account through an
|
2448
|
+
# organization instead of directly by the account ID, you must specify a
|
2449
|
+
# `RoleArn` with proper permissions in the `Target` structure, instead
|
2450
|
+
# of here in this parameter.
|
2451
|
+
#
|
2391
2452
|
# @option params [Array<Types::Tag>] :tags
|
2392
2453
|
# The list of key-value pairs to associate with the rule.
|
2393
2454
|
#
|
@@ -2443,13 +2504,13 @@ module Aws::CloudWatchEvents
|
|
2443
2504
|
#
|
2444
2505
|
# * API Gateway
|
2445
2506
|
#
|
2446
|
-
# *
|
2507
|
+
# * Batch job queue
|
2447
2508
|
#
|
2448
2509
|
# * CloudWatch Logs group
|
2449
2510
|
#
|
2450
2511
|
# * CodeBuild project
|
2451
2512
|
#
|
2452
|
-
# *
|
2513
|
+
# * CodePipeline
|
2453
2514
|
#
|
2454
2515
|
# * Amazon EC2 `CreateSnapshot` API call
|
2455
2516
|
#
|
@@ -2461,7 +2522,7 @@ module Aws::CloudWatchEvents
|
|
2461
2522
|
#
|
2462
2523
|
# * Amazon ECS tasks
|
2463
2524
|
#
|
2464
|
-
# * Event bus in a different
|
2525
|
+
# * Event bus in a different Amazon Web Services account or Region.
|
2465
2526
|
#
|
2466
2527
|
# You can use an event bus in the US East (N. Virginia) us-east-1, US
|
2467
2528
|
# West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a
|
@@ -2473,7 +2534,7 @@ module Aws::CloudWatchEvents
|
|
2473
2534
|
#
|
2474
2535
|
# * Kinesis stream (Kinesis Data Stream)
|
2475
2536
|
#
|
2476
|
-
# *
|
2537
|
+
# * Lambda function
|
2477
2538
|
#
|
2478
2539
|
# * Redshift clusters (Data API statement execution)
|
2479
2540
|
#
|
@@ -2489,7 +2550,7 @@ module Aws::CloudWatchEvents
|
|
2489
2550
|
#
|
2490
2551
|
# * Step Functions state machines
|
2491
2552
|
#
|
2492
|
-
# Creating rules with built-in targets is supported only in the
|
2553
|
+
# Creating rules with built-in targets is supported only in the
|
2493
2554
|
# Management Console. The built-in targets are `EC2 CreateSnapshot API
|
2494
2555
|
# call`, `EC2 RebootInstances API call`, `EC2 StopInstances API call`,
|
2495
2556
|
# and `EC2 TerminateInstances API call`.
|
@@ -2501,27 +2562,28 @@ module Aws::CloudWatchEvents
|
|
2501
2562
|
# you can use the `RunCommandParameters` field.
|
2502
2563
|
#
|
2503
2564
|
# To be able to make API calls against the resources that you own,
|
2504
|
-
# Amazon EventBridge
|
2505
|
-
#
|
2506
|
-
#
|
2507
|
-
#
|
2508
|
-
#
|
2509
|
-
#
|
2510
|
-
#
|
2511
|
-
#
|
2512
|
-
# If another
|
2513
|
-
# permission (using `PutPermission`), you can send events to
|
2514
|
-
# account. Set that account's event bus as a target of the rules
|
2515
|
-
# your account. To send the matched events to the other account,
|
2516
|
-
# that account's event bus as the `Arn` value when you run
|
2565
|
+
# Amazon EventBridge needs the appropriate permissions. For Lambda and
|
2566
|
+
# Amazon SNS resources, EventBridge relies on resource-based policies.
|
2567
|
+
# For EC2 instances, Kinesis Data Streams, Step Functions state machines
|
2568
|
+
# and API Gateway REST APIs, EventBridge relies on IAM roles that you
|
2569
|
+
# specify in the `RoleARN` argument in `PutTargets`. For more
|
2570
|
+
# information, see [Authentication and Access Control][2] in the *Amazon
|
2571
|
+
# EventBridge User Guide*.
|
2572
|
+
#
|
2573
|
+
# If another Amazon Web Services account is in the same region and has
|
2574
|
+
# granted you permission (using `PutPermission`), you can send events to
|
2575
|
+
# that account. Set that account's event bus as a target of the rules
|
2576
|
+
# in your account. To send the matched events to the other account,
|
2577
|
+
# specify that account's event bus as the `Arn` value when you run
|
2517
2578
|
# `PutTargets`. If your account sends events to another account, your
|
2518
2579
|
# account is charged for each sent event. Each event sent to another
|
2519
2580
|
# account is charged as a custom event. The account receiving the event
|
2520
2581
|
# is not charged. For more information, see [Amazon EventBridge
|
2521
|
-
#
|
2582
|
+
# Pricing][3].
|
2522
2583
|
#
|
2523
2584
|
# <note markdown="1"> `Input`, `InputPath`, and `InputTransformer` are not available with
|
2524
|
-
# `PutTarget` if the target is an event bus of a different
|
2585
|
+
# `PutTarget` if the target is an event bus of a different Amazon Web
|
2586
|
+
# Services account.
|
2525
2587
|
#
|
2526
2588
|
# </note>
|
2527
2589
|
#
|
@@ -2529,11 +2591,11 @@ module Aws::CloudWatchEvents
|
|
2529
2591
|
# that account granted permission to your account through an
|
2530
2592
|
# organization instead of directly by the account ID, then you must
|
2531
2593
|
# specify a `RoleArn` with proper permissions in the `Target` structure.
|
2532
|
-
# For more information, see [Sending and Receiving Events Between
|
2533
|
-
# Accounts][4] in the *Amazon EventBridge User Guide*.
|
2594
|
+
# For more information, see [Sending and Receiving Events Between Amazon
|
2595
|
+
# Web Services Accounts][4] in the *Amazon EventBridge User Guide*.
|
2534
2596
|
#
|
2535
2597
|
# For more information about enabling cross-account events, see
|
2536
|
-
# PutPermission.
|
2598
|
+
# [PutPermission][5].
|
2537
2599
|
#
|
2538
2600
|
# **Input**, **InputPath**, and **InputTransformer** are mutually
|
2539
2601
|
# exclusive and optional parameters of a target. When a rule is
|
@@ -2572,8 +2634,9 @@ module Aws::CloudWatchEvents
|
|
2572
2634
|
#
|
2573
2635
|
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html
|
2574
2636
|
# [2]: https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html
|
2575
|
-
# [3]:
|
2637
|
+
# [3]: http://aws.amazon.com/eventbridge/pricing/
|
2576
2638
|
# [4]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
|
2639
|
+
# [5]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html
|
2577
2640
|
#
|
2578
2641
|
# @option params [required, String] :rule
|
2579
2642
|
# The name of the rule.
|
@@ -2622,7 +2685,7 @@ module Aws::CloudWatchEvents
|
|
2622
2685
|
# ecs_parameters: {
|
2623
2686
|
# task_definition_arn: "Arn", # required
|
2624
2687
|
# task_count: 1,
|
2625
|
-
# launch_type: "EC2", # accepts EC2, FARGATE
|
2688
|
+
# launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
|
2626
2689
|
# network_configuration: {
|
2627
2690
|
# awsvpc_configuration: {
|
2628
2691
|
# subnets: ["String"], # required
|
@@ -2728,11 +2791,15 @@ module Aws::CloudWatchEvents
|
|
2728
2791
|
req.send_request(options)
|
2729
2792
|
end
|
2730
2793
|
|
2731
|
-
# Revokes the permission of another
|
2732
|
-
# to the specified event bus. Specify the account to
|
2733
|
-
# `StatementId` value that you associated with the account
|
2734
|
-
# granted it permission with `PutPermission`. You can find the
|
2735
|
-
# `StatementId` by using DescribeEventBus.
|
2794
|
+
# Revokes the permission of another Amazon Web Services account to be
|
2795
|
+
# able to put events to the specified event bus. Specify the account to
|
2796
|
+
# revoke by the `StatementId` value that you associated with the account
|
2797
|
+
# when you granted it permission with `PutPermission`. You can find the
|
2798
|
+
# `StatementId` by using [DescribeEventBus][1].
|
2799
|
+
#
|
2800
|
+
#
|
2801
|
+
#
|
2802
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventBus.html
|
2736
2803
|
#
|
2737
2804
|
# @option params [String] :statement_id
|
2738
2805
|
# The statement ID corresponding to the account that is no longer
|
@@ -2787,11 +2854,11 @@ module Aws::CloudWatchEvents
|
|
2787
2854
|
# The IDs of the targets to remove from the rule.
|
2788
2855
|
#
|
2789
2856
|
# @option params [Boolean] :force
|
2790
|
-
# If this is a managed rule, created by an
|
2791
|
-
# you must specify `Force` as `True` to remove targets.
|
2792
|
-
# is ignored for rules that are not managed rules. You
|
2793
|
-
# a rule is a managed rule by using `DescribeRule` or
|
2794
|
-
# checking the `ManagedBy` field of the response.
|
2857
|
+
# If this is a managed rule, created by an Amazon Web Services service
|
2858
|
+
# on your behalf, you must specify `Force` as `True` to remove targets.
|
2859
|
+
# This parameter is ignored for rules that are not managed rules. You
|
2860
|
+
# can check whether a rule is a managed rule by using `DescribeRule` or
|
2861
|
+
# `ListRules` and checking the `ManagedBy` field of the response.
|
2795
2862
|
#
|
2796
2863
|
# @return [Types::RemoveTargetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2797
2864
|
#
|
@@ -2899,8 +2966,8 @@ module Aws::CloudWatchEvents
|
|
2899
2966
|
# a user permission to access or change only resources with certain tag
|
2900
2967
|
# values. In EventBridge, rules and event buses can be tagged.
|
2901
2968
|
#
|
2902
|
-
# Tags don't have any semantic meaning to
|
2903
|
-
# strictly as strings of characters.
|
2969
|
+
# Tags don't have any semantic meaning to Amazon Web Services and are
|
2970
|
+
# interpreted strictly as strings of characters.
|
2904
2971
|
#
|
2905
2972
|
# You can use the `TagResource` action with a resource that already has
|
2906
2973
|
# tags. If you specify a new tag key, this tag is appended to the list
|
@@ -2941,11 +3008,11 @@ module Aws::CloudWatchEvents
|
|
2941
3008
|
|
2942
3009
|
# Tests whether the specified event pattern matches the provided event.
|
2943
3010
|
#
|
2944
|
-
# Most services in
|
2945
|
-
# Resource Names (ARNs). However, EventBridge uses
|
2946
|
-
# event patterns and rules. Be sure to use the correct
|
2947
|
-
# when creating event patterns so that they match the ARN
|
2948
|
-
# event you want to match.
|
3011
|
+
# Most services in Amazon Web Services treat : or / as the same
|
3012
|
+
# character in Amazon Resource Names (ARNs). However, EventBridge uses
|
3013
|
+
# an exact match in event patterns and rules. Be sure to use the correct
|
3014
|
+
# ARN characters when creating event patterns so that they match the ARN
|
3015
|
+
# syntax in the event you want to match.
|
2949
3016
|
#
|
2950
3017
|
# @option params [required, String] :event_pattern
|
2951
3018
|
# The event pattern. For more information, see [Events and Event
|
@@ -2957,8 +3024,8 @@ module Aws::CloudWatchEvents
|
|
2957
3024
|
#
|
2958
3025
|
# @option params [required, String] :event
|
2959
3026
|
# The event, in JSON format, to test against the event pattern. The JSON
|
2960
|
-
# must follow the format specified in [
|
2961
|
-
# fields are mandatory:
|
3027
|
+
# must follow the format specified in [Amazon Web Services Events][1],
|
3028
|
+
# and the following fields are mandatory:
|
2962
3029
|
#
|
2963
3030
|
# * `id`
|
2964
3031
|
#
|
@@ -3255,7 +3322,7 @@ module Aws::CloudWatchEvents
|
|
3255
3322
|
params: params,
|
3256
3323
|
config: config)
|
3257
3324
|
context[:gem_name] = 'aws-sdk-cloudwatchevents'
|
3258
|
-
context[:gem_version] = '1.
|
3325
|
+
context[:gem_version] = '1.53.0'
|
3259
3326
|
Seahorse::Client::Request.new(handlers, context)
|
3260
3327
|
end
|
3261
3328
|
|