aws-sdk-eventbridge 1.27.0 → 1.31.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-eventbridge/client.rb +204 -146
- data/lib/aws-sdk-eventbridge/types.rb +148 -118
- data/lib/aws-sdk-eventbridge.rb +1 -1
- metadata +5 -5
@@ -462,7 +462,7 @@ module Aws::EventBridge
|
|
462
462
|
# The name for the archive to create.
|
463
463
|
#
|
464
464
|
# @option params [required, String] :event_source_arn
|
465
|
-
# The ARN of the event
|
465
|
+
# The ARN of the event bus that sends events to the archive.
|
466
466
|
#
|
467
467
|
# @option params [String] :description
|
468
468
|
# A description for the archive.
|
@@ -672,43 +672,45 @@ module Aws::EventBridge
|
|
672
672
|
end
|
673
673
|
|
674
674
|
# Called by an SaaS partner to create a partner event source. This
|
675
|
-
# operation is not used by
|
675
|
+
# operation is not used by Amazon Web Services customers.
|
676
676
|
#
|
677
|
-
# Each partner event source can be used by one
|
678
|
-
# matching partner event bus in that
|
679
|
-
#
|
680
|
-
# receive those event
|
677
|
+
# Each partner event source can be used by one Amazon Web Services
|
678
|
+
# account to create a matching partner event bus in that Amazon Web
|
679
|
+
# Services account. A SaaS partner must create one partner event source
|
680
|
+
# for each Amazon Web Services account that wants to receive those event
|
681
|
+
# types.
|
681
682
|
#
|
682
683
|
# A partner event source creates events based on resources within the
|
683
684
|
# SaaS partner's service or application.
|
684
685
|
#
|
685
|
-
# An
|
686
|
-
# partner event source can use that event bus to receive
|
687
|
-
# partner, and then process them using
|
686
|
+
# An Amazon Web Services account that creates a partner event bus that
|
687
|
+
# matches the partner event source can use that event bus to receive
|
688
|
+
# events from the partner, and then process them using Amazon Web
|
689
|
+
# Services Events rules and targets.
|
688
690
|
#
|
689
691
|
# Partner event source names follow this format:
|
690
692
|
#
|
691
693
|
# ` partner_name/event_namespace/event_name `
|
692
694
|
#
|
693
695
|
# *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.
|
696
|
+
# identifies the partner to Amazon Web Services customers.
|
697
|
+
# *event\_namespace* is determined by the partner and is a way for the
|
698
|
+
# partner to categorize their events. *event\_name* is determined by the
|
699
|
+
# partner, and should uniquely identify an event-generating resource
|
700
|
+
# within the partner system. The combination of *event\_namespace* and
|
701
|
+
# *event\_name* should help Amazon Web Services customers decide whether
|
702
|
+
# to create an event bus to receive these events.
|
701
703
|
#
|
702
704
|
# @option params [required, String] :name
|
703
705
|
# The name of the partner event source. This name must be unique and
|
704
706
|
# 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.
|
707
|
+
# Amazon Web Services account that wants to use this partner event
|
708
|
+
# source must create a partner event bus with a name that matches the
|
709
|
+
# name of the partner event source.
|
708
710
|
#
|
709
711
|
# @option params [required, String] :account
|
710
|
-
# The
|
711
|
-
# event bus for this partner event source.
|
712
|
+
# The Amazon Web Services account ID that is permitted to create a
|
713
|
+
# matching partner event bus for this partner event source.
|
712
714
|
#
|
713
715
|
# @return [Types::CreatePartnerEventSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
714
716
|
#
|
@@ -743,7 +745,11 @@ module Aws::EventBridge
|
|
743
745
|
# it is deleted.
|
744
746
|
#
|
745
747
|
# To activate a deactivated partner event source, use
|
746
|
-
# ActivateEventSource.
|
748
|
+
# [ActivateEventSource][1].
|
749
|
+
#
|
750
|
+
#
|
751
|
+
#
|
752
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ActivateEventSource.html
|
747
753
|
#
|
748
754
|
# @option params [required, String] :name
|
749
755
|
# The name of the partner event source to deactivate.
|
@@ -908,17 +914,18 @@ module Aws::EventBridge
|
|
908
914
|
end
|
909
915
|
|
910
916
|
# This operation is used by SaaS partners to delete a partner event
|
911
|
-
# source. This operation is not used by
|
917
|
+
# source. This operation is not used by Amazon Web Services customers.
|
912
918
|
#
|
913
919
|
# When you delete an event source, the status of the corresponding
|
914
|
-
# partner event bus in the
|
920
|
+
# partner event bus in the Amazon Web Services customer account becomes
|
921
|
+
# DELETED.
|
915
922
|
#
|
916
923
|
# @option params [required, String] :name
|
917
924
|
# The name of the event source to delete.
|
918
925
|
#
|
919
926
|
# @option params [required, String] :account
|
920
|
-
# The
|
921
|
-
# created for.
|
927
|
+
# The Amazon Web Services account ID of the Amazon Web Services customer
|
928
|
+
# that the event source was created for.
|
922
929
|
#
|
923
930
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
924
931
|
#
|
@@ -941,7 +948,7 @@ module Aws::EventBridge
|
|
941
948
|
# Deletes the specified rule.
|
942
949
|
#
|
943
950
|
# Before you can delete the rule, you must remove all targets, using
|
944
|
-
# RemoveTargets.
|
951
|
+
# [RemoveTargets][1].
|
945
952
|
#
|
946
953
|
# When you delete a rule, incoming events might continue to match to the
|
947
954
|
# deleted rule. Allow a short period of time for changes to take effect.
|
@@ -950,11 +957,16 @@ module Aws::EventBridge
|
|
950
957
|
# will succeed. When you call delete rule for a non-existent custom
|
951
958
|
# eventbus, `ResourceNotFoundException` is returned.
|
952
959
|
#
|
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
|
960
|
+
# Managed rules are rules created and managed by another Amazon Web
|
961
|
+
# Services service on your behalf. These rules are created by those
|
962
|
+
# other Amazon Web Services services to support functionality in those
|
963
|
+
# services. You can delete these rules using the `Force` option, but you
|
964
|
+
# should do so only if you are sure the other service is not still using
|
965
|
+
# that rule.
|
966
|
+
#
|
967
|
+
#
|
968
|
+
#
|
969
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemoveTargets.html
|
958
970
|
#
|
959
971
|
# @option params [required, String] :name
|
960
972
|
# The name of the rule.
|
@@ -964,11 +976,11 @@ module Aws::EventBridge
|
|
964
976
|
# this, the default event bus is used.
|
965
977
|
#
|
966
978
|
# @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.
|
979
|
+
# If this is a managed rule, created by an Amazon Web Services service
|
980
|
+
# on your behalf, you must specify `Force` as `True` to delete the rule.
|
981
|
+
# This parameter is ignored for rules that are not managed rules. You
|
982
|
+
# can check whether a rule is a managed rule by using `DescribeRule` or
|
983
|
+
# `ListRules` and checking the `ManagedBy` field of the response.
|
972
984
|
#
|
973
985
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
974
986
|
#
|
@@ -1160,15 +1172,21 @@ module Aws::EventBridge
|
|
1160
1172
|
end
|
1161
1173
|
|
1162
1174
|
# 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.
|
1175
|
+
# the external Amazon Web Services accounts that are permitted to write
|
1176
|
+
# events to your default event bus, and the associated policy. For
|
1177
|
+
# custom event buses and partner event buses, it displays the name, ARN,
|
1178
|
+
# policy, state, and creation time.
|
1167
1179
|
#
|
1168
1180
|
# To enable your account to receive events from other accounts on its
|
1169
|
-
# default event bus, use PutPermission.
|
1181
|
+
# default event bus, use [PutPermission][1].
|
1182
|
+
#
|
1183
|
+
# For more information about partner event buses, see
|
1184
|
+
# [CreateEventBus][2].
|
1170
1185
|
#
|
1171
|
-
#
|
1186
|
+
#
|
1187
|
+
#
|
1188
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html
|
1189
|
+
# [2]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html
|
1172
1190
|
#
|
1173
1191
|
# @option params [String] :name
|
1174
1192
|
# The name or ARN of the event bus to show details for. If you omit
|
@@ -1241,9 +1259,14 @@ module Aws::EventBridge
|
|
1241
1259
|
end
|
1242
1260
|
|
1243
1261
|
# 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
|
1262
|
+
# event source that they have created. Amazon Web Services customers do
|
1263
|
+
# not use this operation. Instead, Amazon Web Services customers can use
|
1264
|
+
# [DescribeEventSource][1] to see details about a partner event source
|
1265
|
+
# that is shared with them.
|
1266
|
+
#
|
1267
|
+
#
|
1268
|
+
#
|
1269
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventSource.html
|
1247
1270
|
#
|
1248
1271
|
# @option params [required, String] :name
|
1249
1272
|
# The name of the event source to display.
|
@@ -1337,7 +1360,11 @@ module Aws::EventBridge
|
|
1337
1360
|
# Describes the specified rule.
|
1338
1361
|
#
|
1339
1362
|
# DescribeRule does not list the targets of a rule. To see the targets
|
1340
|
-
# associated with a rule, use ListTargetsByRule.
|
1363
|
+
# associated with a rule, use [ListTargetsByRule][1].
|
1364
|
+
#
|
1365
|
+
#
|
1366
|
+
#
|
1367
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html
|
1341
1368
|
#
|
1342
1369
|
# @option params [required, String] :name
|
1343
1370
|
# The name of the rule.
|
@@ -1663,8 +1690,12 @@ module Aws::EventBridge
|
|
1663
1690
|
end
|
1664
1691
|
|
1665
1692
|
# You can use this to see all the partner event sources that have been
|
1666
|
-
# shared with your
|
1667
|
-
# sources, see CreateEventBus.
|
1693
|
+
# shared with your Amazon Web Services account. For more information
|
1694
|
+
# about partner event sources, see [CreateEventBus][1].
|
1695
|
+
#
|
1696
|
+
#
|
1697
|
+
#
|
1698
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html
|
1668
1699
|
#
|
1669
1700
|
# @option params [String] :name_prefix
|
1670
1701
|
# Specifying this limits the results to only those partner event sources
|
@@ -1712,9 +1743,10 @@ module Aws::EventBridge
|
|
1712
1743
|
req.send_request(options)
|
1713
1744
|
end
|
1714
1745
|
|
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
|
1746
|
+
# An SaaS partner can use this operation to display the Amazon Web
|
1747
|
+
# Services account ID that a particular partner event source name is
|
1748
|
+
# associated with. This operation is not used by Amazon Web Services
|
1749
|
+
# customers.
|
1718
1750
|
#
|
1719
1751
|
# @option params [required, String] :event_source_name
|
1720
1752
|
# The name of the partner event source to display account information
|
@@ -1761,8 +1793,8 @@ module Aws::EventBridge
|
|
1761
1793
|
end
|
1762
1794
|
|
1763
1795
|
# 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.
|
1796
|
+
# source names that they have created. This operation is not used by
|
1797
|
+
# Amazon Web Services customers.
|
1766
1798
|
#
|
1767
1799
|
# @option params [required, String] :name_prefix
|
1768
1800
|
# If you specify this, the results are limited to only those partner
|
@@ -1818,7 +1850,7 @@ module Aws::EventBridge
|
|
1818
1850
|
# The state of the replay.
|
1819
1851
|
#
|
1820
1852
|
# @option params [String] :event_source_arn
|
1821
|
-
# The ARN of the
|
1853
|
+
# The ARN of the archive from which the events are replayed.
|
1822
1854
|
#
|
1823
1855
|
# @option params [String] :next_token
|
1824
1856
|
# The token returned by a previous call to retrieve the next set of
|
@@ -1916,7 +1948,11 @@ module Aws::EventBridge
|
|
1916
1948
|
# or you can provide a prefix to match to the rule names.
|
1917
1949
|
#
|
1918
1950
|
# ListRules does not list the targets of a rule. To see the targets
|
1919
|
-
# associated with a rule, use ListTargetsByRule.
|
1951
|
+
# associated with a rule, use [ListTargetsByRule][1].
|
1952
|
+
#
|
1953
|
+
#
|
1954
|
+
#
|
1955
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html
|
1920
1956
|
#
|
1921
1957
|
# @option params [String] :name_prefix
|
1922
1958
|
# The prefix matching the rule name.
|
@@ -2048,7 +2084,7 @@ module Aws::EventBridge
|
|
2048
2084
|
# resp.targets[0].run_command_parameters.run_command_targets[0].values[0] #=> String
|
2049
2085
|
# resp.targets[0].ecs_parameters.task_definition_arn #=> String
|
2050
2086
|
# resp.targets[0].ecs_parameters.task_count #=> Integer
|
2051
|
-
# resp.targets[0].ecs_parameters.launch_type #=> String, one of "EC2", "FARGATE"
|
2087
|
+
# resp.targets[0].ecs_parameters.launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
|
2052
2088
|
# resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.subnets #=> Array
|
2053
2089
|
# resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.subnets[0] #=> String
|
2054
2090
|
# resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.security_groups #=> Array
|
@@ -2154,7 +2190,7 @@ module Aws::EventBridge
|
|
2154
2190
|
end
|
2155
2191
|
|
2156
2192
|
# This is used by SaaS partners to write events to a customer's partner
|
2157
|
-
# event bus.
|
2193
|
+
# event bus. Amazon Web Services customers do not use this operation.
|
2158
2194
|
#
|
2159
2195
|
# @option params [required, Array<Types::PutPartnerEventsRequestEntry>] :entries
|
2160
2196
|
# The list of events to write to the event bus.
|
@@ -2195,30 +2231,31 @@ module Aws::EventBridge
|
|
2195
2231
|
req.send_request(options)
|
2196
2232
|
end
|
2197
2233
|
|
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
|
2234
|
+
# Running `PutPermission` permits the specified Amazon Web Services
|
2235
|
+
# account or Amazon Web Services organization to put events to the
|
2236
|
+
# specified *event bus*. Amazon EventBridge (CloudWatch Events) rules in
|
2237
|
+
# your account are triggered by these events arriving to an event bus in
|
2238
|
+
# your account.
|
2202
2239
|
#
|
2203
2240
|
# For another account to send events to your account, that external
|
2204
2241
|
# account must have an EventBridge rule with your account's event bus
|
2205
2242
|
# as a target.
|
2206
2243
|
#
|
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
|
2244
|
+
# To enable multiple Amazon Web Services accounts to put events to your
|
2245
|
+
# event bus, run `PutPermission` once for each of these accounts. Or, if
|
2246
|
+
# all the accounts are members of the same Amazon Web Services
|
2247
|
+
# organization, you can run `PutPermission` once specifying `Principal`
|
2248
|
+
# as "*" and specifying the Amazon Web Services organization ID in
|
2249
|
+
# `Condition`, to grant permissions to all accounts in that
|
2250
|
+
# organization.
|
2213
2251
|
#
|
2214
2252
|
# If you grant permissions using an organization, then accounts in that
|
2215
2253
|
# organization must specify a `RoleArn` with proper permissions when
|
2216
2254
|
# 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*.
|
2255
|
+
# more information, see [Sending and Receiving Events Between Amazon Web
|
2256
|
+
# Services Accounts][1] in the *Amazon EventBridge User Guide*.
|
2219
2257
|
#
|
2220
|
-
# The permission policy on the
|
2221
|
-
# size.
|
2258
|
+
# The permission policy on the event bus cannot exceed 10 KB in size.
|
2222
2259
|
#
|
2223
2260
|
#
|
2224
2261
|
#
|
@@ -2230,12 +2267,11 @@ module Aws::EventBridge
|
|
2230
2267
|
#
|
2231
2268
|
# @option params [String] :action
|
2232
2269
|
# The action that you are enabling the other account to perform.
|
2233
|
-
# Currently, this must be `events:PutEvents`.
|
2234
2270
|
#
|
2235
2271
|
# @option params [String] :principal
|
2236
|
-
# The 12-digit
|
2237
|
-
# your default event bus. Specify "*" to permit any
|
2238
|
-
# events to your default event bus.
|
2272
|
+
# The 12-digit Amazon Web Services account ID that you are permitting to
|
2273
|
+
# put events to your default event bus. Specify "*" to permit any
|
2274
|
+
# account to put events to your default event bus.
|
2239
2275
|
#
|
2240
2276
|
# If you specify "*" without specifying `Condition`, avoid creating
|
2241
2277
|
# rules that may match undesirable events. To create more secure rules,
|
@@ -2248,17 +2284,23 @@ module Aws::EventBridge
|
|
2248
2284
|
# An identifier string for the external account that you are granting
|
2249
2285
|
# permissions to. If you later want to revoke the permission for this
|
2250
2286
|
# external account, specify this `StatementId` when you run
|
2251
|
-
# RemovePermission.
|
2287
|
+
# [RemovePermission][1].
|
2288
|
+
#
|
2289
|
+
#
|
2290
|
+
#
|
2291
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html
|
2252
2292
|
#
|
2253
2293
|
# @option params [Types::Condition] :condition
|
2254
2294
|
# 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
|
-
#
|
2295
|
+
# fulfill a certain condition, such as being a member of a certain
|
2296
|
+
# Amazon Web Services organization. For more information about Amazon
|
2297
|
+
# Web Services Organizations, see [What Is Amazon Web Services
|
2298
|
+
# Organizations][1] in the *Amazon Web Services Organizations User
|
2299
|
+
# Guide*.
|
2258
2300
|
#
|
2259
|
-
# If you specify `Condition` with an
|
2260
|
-
# "*" as the value for `Principal`, you grant
|
2261
|
-
# accounts in the named organization.
|
2301
|
+
# If you specify `Condition` with an Amazon Web Services organization
|
2302
|
+
# ID, and specify "*" as the value for `Principal`, you grant
|
2303
|
+
# permission to all the accounts in the named organization.
|
2262
2304
|
#
|
2263
2305
|
# The `Condition` is a JSON string which must contain `Type`, `Key`, and
|
2264
2306
|
# `Value` fields.
|
@@ -2300,15 +2342,15 @@ module Aws::EventBridge
|
|
2300
2342
|
|
2301
2343
|
# Creates or updates the specified rule. Rules are enabled by default,
|
2302
2344
|
# or based on value of the state. You can disable a rule using
|
2303
|
-
# DisableRule.
|
2345
|
+
# [DisableRule][1].
|
2304
2346
|
#
|
2305
2347
|
# 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.
|
2348
|
+
# generated by Amazon Web Services services go to your account's
|
2349
|
+
# default event bus. Events generated by SaaS partner services or
|
2350
|
+
# applications go to the matching partner event bus. If you have custom
|
2351
|
+
# applications or services, you can specify whether their events go to
|
2352
|
+
# your default event bus or a custom event bus that you have created.
|
2353
|
+
# For more information, see [CreateEventBus][2].
|
2312
2354
|
#
|
2313
2355
|
# If you are updating an existing rule, the rule is replaced with what
|
2314
2356
|
# you specify in this `PutRule` command. If you omit arguments in
|
@@ -2335,13 +2377,13 @@ module Aws::EventBridge
|
|
2335
2377
|
#
|
2336
2378
|
# If you are updating an existing rule, any tags you specify in the
|
2337
2379
|
# `PutRule` operation are ignored. To update the tags of an existing
|
2338
|
-
# rule, use TagResource and UntagResource.
|
2380
|
+
# rule, use [TagResource][3] and [UntagResource][4].
|
2339
2381
|
#
|
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.
|
2382
|
+
# Most services in Amazon Web Services treat : or / as the same
|
2383
|
+
# character in Amazon Resource Names (ARNs). However, EventBridge uses
|
2384
|
+
# an exact match in event patterns and rules. Be sure to use the correct
|
2385
|
+
# ARN characters when creating event patterns so that they match the ARN
|
2386
|
+
# syntax in the event you want to match.
|
2345
2387
|
#
|
2346
2388
|
# In EventBridge, it is possible to create rules that lead to infinite
|
2347
2389
|
# loops, where a rule is fired repeatedly. For example, a rule might
|
@@ -2357,11 +2399,15 @@ module Aws::EventBridge
|
|
2357
2399
|
# An infinite loop can quickly cause higher than expected charges. We
|
2358
2400
|
# recommend that you use budgeting, which alerts you when charges exceed
|
2359
2401
|
# your specified limit. For more information, see [Managing Your Costs
|
2360
|
-
# with Budgets][
|
2402
|
+
# with Budgets][5].
|
2361
2403
|
#
|
2362
2404
|
#
|
2363
2405
|
#
|
2364
|
-
# [1]: https://docs.aws.amazon.com/
|
2406
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html
|
2407
|
+
# [2]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html
|
2408
|
+
# [3]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_TagResource.html
|
2409
|
+
# [4]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UntagResource.html
|
2410
|
+
# [5]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html
|
2365
2411
|
#
|
2366
2412
|
# @option params [required, String] :name
|
2367
2413
|
# The name of the rule that you are creating or updating.
|
@@ -2388,6 +2434,12 @@ module Aws::EventBridge
|
|
2388
2434
|
# The Amazon Resource Name (ARN) of the IAM role associated with the
|
2389
2435
|
# rule.
|
2390
2436
|
#
|
2437
|
+
# If you're setting an event bus in another account as the target and
|
2438
|
+
# that account granted permission to your account through an
|
2439
|
+
# organization instead of directly by the account ID, you must specify a
|
2440
|
+
# `RoleArn` with proper permissions in the `Target` structure, instead
|
2441
|
+
# of here in this parameter.
|
2442
|
+
#
|
2391
2443
|
# @option params [Array<Types::Tag>] :tags
|
2392
2444
|
# The list of key-value pairs to associate with the rule.
|
2393
2445
|
#
|
@@ -2443,13 +2495,13 @@ module Aws::EventBridge
|
|
2443
2495
|
#
|
2444
2496
|
# * API Gateway
|
2445
2497
|
#
|
2446
|
-
# *
|
2498
|
+
# * Batch job queue
|
2447
2499
|
#
|
2448
2500
|
# * CloudWatch Logs group
|
2449
2501
|
#
|
2450
2502
|
# * CodeBuild project
|
2451
2503
|
#
|
2452
|
-
# *
|
2504
|
+
# * CodePipeline
|
2453
2505
|
#
|
2454
2506
|
# * Amazon EC2 `CreateSnapshot` API call
|
2455
2507
|
#
|
@@ -2461,7 +2513,7 @@ module Aws::EventBridge
|
|
2461
2513
|
#
|
2462
2514
|
# * Amazon ECS tasks
|
2463
2515
|
#
|
2464
|
-
# * Event bus in a different
|
2516
|
+
# * Event bus in a different Amazon Web Services account or Region.
|
2465
2517
|
#
|
2466
2518
|
# You can use an event bus in the US East (N. Virginia) us-east-1, US
|
2467
2519
|
# West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a
|
@@ -2473,7 +2525,7 @@ module Aws::EventBridge
|
|
2473
2525
|
#
|
2474
2526
|
# * Kinesis stream (Kinesis Data Stream)
|
2475
2527
|
#
|
2476
|
-
# *
|
2528
|
+
# * Lambda function
|
2477
2529
|
#
|
2478
2530
|
# * Redshift clusters (Data API statement execution)
|
2479
2531
|
#
|
@@ -2489,10 +2541,10 @@ module Aws::EventBridge
|
|
2489
2541
|
#
|
2490
2542
|
# * Step Functions state machines
|
2491
2543
|
#
|
2492
|
-
# Creating rules with built-in targets is supported only in the
|
2493
|
-
# Management Console. The built-in targets are `EC2
|
2494
|
-
# call`, `EC2 RebootInstances API call`, `EC2
|
2495
|
-
# and `EC2 TerminateInstances API call`.
|
2544
|
+
# Creating rules with built-in targets is supported only in the Amazon
|
2545
|
+
# Web Services Management Console. The built-in targets are `EC2
|
2546
|
+
# CreateSnapshot API call`, `EC2 RebootInstances API call`, `EC2
|
2547
|
+
# StopInstances API call`, and `EC2 TerminateInstances API call`.
|
2496
2548
|
#
|
2497
2549
|
# For some target types, `PutTargets` provides target-specific
|
2498
2550
|
# parameters. If the target is a Kinesis data stream, you can optionally
|
@@ -2501,27 +2553,28 @@ module Aws::EventBridge
|
|
2501
2553
|
# you can use the `RunCommandParameters` field.
|
2502
2554
|
#
|
2503
2555
|
# 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
|
2556
|
+
# Amazon EventBridge needs the appropriate permissions. For Lambda and
|
2557
|
+
# Amazon SNS resources, EventBridge relies on resource-based policies.
|
2558
|
+
# For EC2 instances, Kinesis Data Streams, Step Functions state machines
|
2559
|
+
# and API Gateway REST APIs, EventBridge relies on IAM roles that you
|
2560
|
+
# specify in the `RoleARN` argument in `PutTargets`. For more
|
2561
|
+
# information, see [Authentication and Access Control][2] in the *Amazon
|
2562
|
+
# EventBridge User Guide*.
|
2563
|
+
#
|
2564
|
+
# If another Amazon Web Services account is in the same region and has
|
2565
|
+
# granted you permission (using `PutPermission`), you can send events to
|
2566
|
+
# that account. Set that account's event bus as a target of the rules
|
2567
|
+
# in your account. To send the matched events to the other account,
|
2568
|
+
# specify that account's event bus as the `Arn` value when you run
|
2517
2569
|
# `PutTargets`. If your account sends events to another account, your
|
2518
2570
|
# account is charged for each sent event. Each event sent to another
|
2519
2571
|
# account is charged as a custom event. The account receiving the event
|
2520
2572
|
# is not charged. For more information, see [Amazon EventBridge
|
2521
|
-
#
|
2573
|
+
# Pricing][3].
|
2522
2574
|
#
|
2523
2575
|
# <note markdown="1"> `Input`, `InputPath`, and `InputTransformer` are not available with
|
2524
|
-
# `PutTarget` if the target is an event bus of a different
|
2576
|
+
# `PutTarget` if the target is an event bus of a different Amazon Web
|
2577
|
+
# Services account.
|
2525
2578
|
#
|
2526
2579
|
# </note>
|
2527
2580
|
#
|
@@ -2529,11 +2582,11 @@ module Aws::EventBridge
|
|
2529
2582
|
# that account granted permission to your account through an
|
2530
2583
|
# organization instead of directly by the account ID, then you must
|
2531
2584
|
# 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*.
|
2585
|
+
# For more information, see [Sending and Receiving Events Between Amazon
|
2586
|
+
# Web Services Accounts][4] in the *Amazon EventBridge User Guide*.
|
2534
2587
|
#
|
2535
2588
|
# For more information about enabling cross-account events, see
|
2536
|
-
# PutPermission.
|
2589
|
+
# [PutPermission][5].
|
2537
2590
|
#
|
2538
2591
|
# **Input**, **InputPath**, and **InputTransformer** are mutually
|
2539
2592
|
# exclusive and optional parameters of a target. When a rule is
|
@@ -2572,8 +2625,9 @@ module Aws::EventBridge
|
|
2572
2625
|
#
|
2573
2626
|
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html
|
2574
2627
|
# [2]: https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html
|
2575
|
-
# [3]:
|
2628
|
+
# [3]: http://aws.amazon.com/eventbridge/pricing/
|
2576
2629
|
# [4]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
|
2630
|
+
# [5]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html
|
2577
2631
|
#
|
2578
2632
|
# @option params [required, String] :rule
|
2579
2633
|
# The name of the rule.
|
@@ -2622,7 +2676,7 @@ module Aws::EventBridge
|
|
2622
2676
|
# ecs_parameters: {
|
2623
2677
|
# task_definition_arn: "Arn", # required
|
2624
2678
|
# task_count: 1,
|
2625
|
-
# launch_type: "EC2", # accepts EC2, FARGATE
|
2679
|
+
# launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
|
2626
2680
|
# network_configuration: {
|
2627
2681
|
# awsvpc_configuration: {
|
2628
2682
|
# subnets: ["String"], # required
|
@@ -2728,11 +2782,15 @@ module Aws::EventBridge
|
|
2728
2782
|
req.send_request(options)
|
2729
2783
|
end
|
2730
2784
|
|
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.
|
2785
|
+
# Revokes the permission of another Amazon Web Services account to be
|
2786
|
+
# able to put events to the specified event bus. Specify the account to
|
2787
|
+
# revoke by the `StatementId` value that you associated with the account
|
2788
|
+
# when you granted it permission with `PutPermission`. You can find the
|
2789
|
+
# `StatementId` by using [DescribeEventBus][1].
|
2790
|
+
#
|
2791
|
+
#
|
2792
|
+
#
|
2793
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventBus.html
|
2736
2794
|
#
|
2737
2795
|
# @option params [String] :statement_id
|
2738
2796
|
# The statement ID corresponding to the account that is no longer
|
@@ -2787,11 +2845,11 @@ module Aws::EventBridge
|
|
2787
2845
|
# The IDs of the targets to remove from the rule.
|
2788
2846
|
#
|
2789
2847
|
# @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.
|
2848
|
+
# If this is a managed rule, created by an Amazon Web Services service
|
2849
|
+
# on your behalf, you must specify `Force` as `True` to remove targets.
|
2850
|
+
# This parameter is ignored for rules that are not managed rules. You
|
2851
|
+
# can check whether a rule is a managed rule by using `DescribeRule` or
|
2852
|
+
# `ListRules` and checking the `ManagedBy` field of the response.
|
2795
2853
|
#
|
2796
2854
|
# @return [Types::RemoveTargetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2797
2855
|
#
|
@@ -2899,8 +2957,8 @@ module Aws::EventBridge
|
|
2899
2957
|
# a user permission to access or change only resources with certain tag
|
2900
2958
|
# values. In EventBridge, rules and event buses can be tagged.
|
2901
2959
|
#
|
2902
|
-
# Tags don't have any semantic meaning to
|
2903
|
-
# strictly as strings of characters.
|
2960
|
+
# Tags don't have any semantic meaning to Amazon Web Services and are
|
2961
|
+
# interpreted strictly as strings of characters.
|
2904
2962
|
#
|
2905
2963
|
# You can use the `TagResource` action with a resource that already has
|
2906
2964
|
# tags. If you specify a new tag key, this tag is appended to the list
|
@@ -2941,11 +2999,11 @@ module Aws::EventBridge
|
|
2941
2999
|
|
2942
3000
|
# Tests whether the specified event pattern matches the provided event.
|
2943
3001
|
#
|
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.
|
3002
|
+
# Most services in Amazon Web Services treat : or / as the same
|
3003
|
+
# character in Amazon Resource Names (ARNs). However, EventBridge uses
|
3004
|
+
# an exact match in event patterns and rules. Be sure to use the correct
|
3005
|
+
# ARN characters when creating event patterns so that they match the ARN
|
3006
|
+
# syntax in the event you want to match.
|
2949
3007
|
#
|
2950
3008
|
# @option params [required, String] :event_pattern
|
2951
3009
|
# The event pattern. For more information, see [Events and Event
|
@@ -2957,8 +3015,8 @@ module Aws::EventBridge
|
|
2957
3015
|
#
|
2958
3016
|
# @option params [required, String] :event
|
2959
3017
|
# The event, in JSON format, to test against the event pattern. The JSON
|
2960
|
-
# must follow the format specified in [
|
2961
|
-
# fields are mandatory:
|
3018
|
+
# must follow the format specified in [Amazon Web Services Events][1],
|
3019
|
+
# and the following fields are mandatory:
|
2962
3020
|
#
|
2963
3021
|
# * `id`
|
2964
3022
|
#
|
@@ -3255,7 +3313,7 @@ module Aws::EventBridge
|
|
3255
3313
|
params: params,
|
3256
3314
|
config: config)
|
3257
3315
|
context[:gem_name] = 'aws-sdk-eventbridge'
|
3258
|
-
context[:gem_version] = '1.
|
3316
|
+
context[:gem_version] = '1.31.0'
|
3259
3317
|
Seahorse::Client::Request.new(handlers, context)
|
3260
3318
|
end
|
3261
3319
|
|