aws-sdk-eventbridge 1.27.0 → 1.28.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 48c7e5f404444a71b03c71dd0a96dc0641d65df42c27f2e48682076bf9446081
4
- data.tar.gz: 219fac4d8d9670c1f87139ee644251ecf1bb315cbd033f8644d2e011d0f1bc9e
3
+ metadata.gz: a1618a0927c207c8c6f1ef83a6cc69e78d168101b42d745a254e5fa178d556f7
4
+ data.tar.gz: 0fb7d2cb90e719fe74fa51506a4737fc19db3c6e70c849f3279dd60f32db18c3
5
5
  SHA512:
6
- metadata.gz: 0e85568274eb77892f28133afa1c9ee7db8ca718cb62f52a505278d613b4423438306f5fa28b42f080262eb0c71b49d6729581dc91b32acbbf0bf29f11898e4a
7
- data.tar.gz: 7013543f552cb7f8e636c0dc5148a4f228afc3d8aaf419cd5e78534cd02099fefc916c56832173d73b449740c1aa53b8a90171a2e8a6b7864809fb0c115762ee
6
+ metadata.gz: 1e33b18d5ce2605dcac512d99e132ab45fbf7c0df7b0d14a27b896c2abd85ab43ef25107db25b7229adb1bf38d4a422169e21724dafeae4622eeb785f8a9f4a8
7
+ data.tar.gz: b13a4bce6232be62a75aa51d908b1eab0210c7f5571a569cea6648d0b2c789274520135898684f9c47a009789899992daae0b6d6dfc93495573ebbf07bd77e4f
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.28.0 (2021-08-04)
5
+ ------------------
6
+
7
+ * Feature - Documentation updates to add EC2 Image Builder as a target on PutTargets.
8
+
4
9
  1.27.0 (2021-07-30)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.27.0
1
+ 1.28.0
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-eventbridge/customizations'
48
48
  # @!group service
49
49
  module Aws::EventBridge
50
50
 
51
- GEM_VERSION = '1.27.0'
51
+ GEM_VERSION = '1.28.0'
52
52
 
53
53
  end
@@ -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 source associated with the archive.
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 AWS customers.
675
+ # operation is not used by Amazon Web Services customers.
676
676
  #
677
- # Each partner event source can be used by one AWS account to create a
678
- # matching partner event bus in that AWS account. A SaaS partner must
679
- # create one partner event source for each AWS account that wants to
680
- # receive those event types.
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 AWS account that creates a partner event bus that matches the
686
- # partner event source can use that event bus to receive events from the
687
- # partner, and then process them using AWS Events rules and targets.
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 AWS customers. *event\_namespace* is
695
- # determined by the partner and is a way for the partner to categorize
696
- # their events. *event\_name* is determined by the partner, and should
697
- # uniquely identify an event-generating resource within the partner
698
- # system. The combination of *event\_namespace* and *event\_name* should
699
- # help AWS customers decide whether to create an event bus to receive
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
- # AWS account that wants to use this partner event source must create a
706
- # partner event bus with a name that matches the name of the partner
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 AWS account ID that is permitted to create a matching partner
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 AWS customers.
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 AWS customer account becomes DELETED.
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 AWS account ID of the AWS customer that the event source was
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 AWS service on
954
- # your behalf. These rules are created by those other AWS services to
955
- # support functionality in those services. You can delete these rules
956
- # using the `Force` option, but you should do so only if you are sure
957
- # the other service is not still using that rule.
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 AWS service on your behalf,
968
- # you must specify `Force` as `True` to delete the rule. This parameter
969
- # is ignored for rules that are not managed rules. You can check whether
970
- # a rule is a managed rule by using `DescribeRule` or `ListRules` and
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 AWS accounts that are permitted to write events to your
1164
- # default event bus, and the associated policy. For custom event buses
1165
- # and partner event buses, it displays the name, ARN, policy, state, and
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
- # For more information about partner event buses, see CreateEventBus.
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. AWS customers do not use this
1245
- # operation. Instead, AWS customers can use DescribeEventSource to see
1246
- # details about a partner event source that is shared with them.
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 AWS account. For more information about partner event
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 AWS account ID
1716
- # that a particular partner event source name is associated with. This
1717
- # operation is not used by AWS customers.
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 AWS
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 event source associated with the replay.
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.
@@ -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. AWS customers do not use this operation.
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 AWS account or AWS
2199
- # organization to put events to the specified *event bus*. Amazon
2200
- # EventBridge (CloudWatch Events) rules in your account are triggered by
2201
- # these events arriving to an event bus in your account.
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 AWS accounts to put events to your event bus, run
2208
- # `PutPermission` once for each of these accounts. Or, if all the
2209
- # accounts are members of the same AWS organization, you can run
2210
- # `PutPermission` once specifying `Principal` as "*" and specifying
2211
- # the AWS organization ID in `Condition`, to grant permissions to all
2212
- # accounts in that organization.
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 AWS
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 default event bus cannot exceed 10 KB in
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 AWS account ID that you are permitting to put events to
2237
- # your default event bus. Specify "*" to permit any account to put
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 AWS
2256
- # organization. For more information about AWS Organizations, see [What
2257
- # Is AWS Organizations][1] in the *AWS Organizations User Guide*.
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 AWS organization ID, and specify
2260
- # "*" as the value for `Principal`, you grant permission to all the
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 AWS services go to your account's default event bus.
2307
- # Events generated by SaaS partner services or applications go to the
2308
- # matching partner event bus. If you have custom applications or
2309
- # services, you can specify whether their events go to your default
2310
- # event bus or a custom event bus that you have created. For more
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 AWS treat : or / as the same character in Amazon
2341
- # Resource Names (ARNs). However, EventBridge uses an exact match in
2342
- # event patterns and rules. Be sure to use the correct ARN characters
2343
- # when creating event patterns so that they match the ARN syntax in the
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][1].
2402
+ # with Budgets][5].
2361
2403
  #
2362
2404
  #
2363
2405
  #
2364
- # [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html
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,16 +2495,18 @@ module Aws::EventBridge
2443
2495
  #
2444
2496
  # * API Gateway
2445
2497
  #
2446
- # * AWS Batch job queue
2498
+ # * Batch job queue
2447
2499
  #
2448
2500
  # * CloudWatch Logs group
2449
2501
  #
2450
2502
  # * CodeBuild project
2451
2503
  #
2452
- # * CodePineline
2504
+ # * CodePipeline
2453
2505
  #
2454
2506
  # * Amazon EC2 `CreateSnapshot` API call
2455
2507
  #
2508
+ # * EC2 Image Builder
2509
+ #
2456
2510
  # * Amazon EC2 `RebootInstances` API call
2457
2511
  #
2458
2512
  # * Amazon EC2 `StopInstances` API call
@@ -2461,7 +2515,7 @@ module Aws::EventBridge
2461
2515
  #
2462
2516
  # * Amazon ECS tasks
2463
2517
  #
2464
- # * Event bus in a different AWS account or Region.
2518
+ # * Event bus in a different Amazon Web Services account or Region.
2465
2519
  #
2466
2520
  # You can use an event bus in the US East (N. Virginia) us-east-1, US
2467
2521
  # West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a
@@ -2473,7 +2527,7 @@ module Aws::EventBridge
2473
2527
  #
2474
2528
  # * Kinesis stream (Kinesis Data Stream)
2475
2529
  #
2476
- # * AWS Lambda function
2530
+ # * Lambda function
2477
2531
  #
2478
2532
  # * Redshift clusters (Data API statement execution)
2479
2533
  #
@@ -2489,10 +2543,10 @@ module Aws::EventBridge
2489
2543
  #
2490
2544
  # * Step Functions state machines
2491
2545
  #
2492
- # Creating rules with built-in targets is supported only in the AWS
2493
- # Management Console. The built-in targets are `EC2 CreateSnapshot API
2494
- # call`, `EC2 RebootInstances API call`, `EC2 StopInstances API call`,
2495
- # and `EC2 TerminateInstances API call`.
2546
+ # Creating rules with built-in targets is supported only in the Amazon
2547
+ # Web Services Management Console. The built-in targets are `EC2
2548
+ # CreateSnapshot API call`, `EC2 RebootInstances API call`, `EC2
2549
+ # StopInstances API call`, and `EC2 TerminateInstances API call`.
2496
2550
  #
2497
2551
  # For some target types, `PutTargets` provides target-specific
2498
2552
  # parameters. If the target is a Kinesis data stream, you can optionally
@@ -2501,27 +2555,28 @@ module Aws::EventBridge
2501
2555
  # you can use the `RunCommandParameters` field.
2502
2556
  #
2503
2557
  # To be able to make API calls against the resources that you own,
2504
- # Amazon EventBridge (CloudWatch Events) needs the appropriate
2505
- # permissions. For AWS Lambda and Amazon SNS resources, EventBridge
2506
- # relies on resource-based policies. For EC2 instances, Kinesis data
2507
- # streams, AWS Step Functions state machines and API Gateway REST APIs,
2508
- # EventBridge relies on IAM roles that you specify in the `RoleARN`
2509
- # argument in `PutTargets`. For more information, see [Authentication
2510
- # and Access Control][2] in the *Amazon EventBridge User Guide*.
2511
- #
2512
- # If another AWS account is in the same region and has granted you
2513
- # permission (using `PutPermission`), you can send events to that
2514
- # account. Set that account's event bus as a target of the rules in
2515
- # your account. To send the matched events to the other account, specify
2516
- # that account's event bus as the `Arn` value when you run
2558
+ # Amazon EventBridge needs the appropriate permissions. For Lambda and
2559
+ # Amazon SNS resources, EventBridge relies on resource-based policies.
2560
+ # For EC2 instances, Kinesis Data Streams, Step Functions state machines
2561
+ # and API Gateway REST APIs, EventBridge relies on IAM roles that you
2562
+ # specify in the `RoleARN` argument in `PutTargets`. For more
2563
+ # information, see [Authentication and Access Control][2] in the *Amazon
2564
+ # EventBridge User Guide*.
2565
+ #
2566
+ # If another Amazon Web Services account is in the same region and has
2567
+ # granted you permission (using `PutPermission`), you can send events to
2568
+ # that account. Set that account's event bus as a target of the rules
2569
+ # in your account. To send the matched events to the other account,
2570
+ # specify that account's event bus as the `Arn` value when you run
2517
2571
  # `PutTargets`. If your account sends events to another account, your
2518
2572
  # account is charged for each sent event. Each event sent to another
2519
2573
  # account is charged as a custom event. The account receiving the event
2520
2574
  # is not charged. For more information, see [Amazon EventBridge
2521
- # (CloudWatch Events) Pricing][3].
2575
+ # Pricing][3].
2522
2576
  #
2523
2577
  # <note markdown="1"> `Input`, `InputPath`, and `InputTransformer` are not available with
2524
- # `PutTarget` if the target is an event bus of a different AWS account.
2578
+ # `PutTarget` if the target is an event bus of a different Amazon Web
2579
+ # Services account.
2525
2580
  #
2526
2581
  # </note>
2527
2582
  #
@@ -2529,11 +2584,11 @@ module Aws::EventBridge
2529
2584
  # that account granted permission to your account through an
2530
2585
  # organization instead of directly by the account ID, then you must
2531
2586
  # specify a `RoleArn` with proper permissions in the `Target` structure.
2532
- # For more information, see [Sending and Receiving Events Between AWS
2533
- # Accounts][4] in the *Amazon EventBridge User Guide*.
2587
+ # For more information, see [Sending and Receiving Events Between Amazon
2588
+ # Web Services Accounts][4] in the *Amazon EventBridge User Guide*.
2534
2589
  #
2535
2590
  # For more information about enabling cross-account events, see
2536
- # PutPermission.
2591
+ # [PutPermission][5].
2537
2592
  #
2538
2593
  # **Input**, **InputPath**, and **InputTransformer** are mutually
2539
2594
  # exclusive and optional parameters of a target. When a rule is
@@ -2572,8 +2627,9 @@ module Aws::EventBridge
2572
2627
  #
2573
2628
  # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html
2574
2629
  # [2]: https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html
2575
- # [3]: https://aws.amazon.com/eventbridge/pricing/
2630
+ # [3]: http://aws.amazon.com/eventbridge/pricing/
2576
2631
  # [4]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
2632
+ # [5]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html
2577
2633
  #
2578
2634
  # @option params [required, String] :rule
2579
2635
  # The name of the rule.
@@ -2728,11 +2784,15 @@ module Aws::EventBridge
2728
2784
  req.send_request(options)
2729
2785
  end
2730
2786
 
2731
- # Revokes the permission of another AWS account to be able to put events
2732
- # to the specified event bus. Specify the account to revoke by the
2733
- # `StatementId` value that you associated with the account when you
2734
- # granted it permission with `PutPermission`. You can find the
2735
- # `StatementId` by using DescribeEventBus.
2787
+ # Revokes the permission of another Amazon Web Services account to be
2788
+ # able to put events to the specified event bus. Specify the account to
2789
+ # revoke by the `StatementId` value that you associated with the account
2790
+ # when you granted it permission with `PutPermission`. You can find the
2791
+ # `StatementId` by using [DescribeEventBus][1].
2792
+ #
2793
+ #
2794
+ #
2795
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventBus.html
2736
2796
  #
2737
2797
  # @option params [String] :statement_id
2738
2798
  # The statement ID corresponding to the account that is no longer
@@ -2787,11 +2847,11 @@ module Aws::EventBridge
2787
2847
  # The IDs of the targets to remove from the rule.
2788
2848
  #
2789
2849
  # @option params [Boolean] :force
2790
- # If this is a managed rule, created by an AWS service on your behalf,
2791
- # you must specify `Force` as `True` to remove targets. This parameter
2792
- # is ignored for rules that are not managed rules. You can check whether
2793
- # a rule is a managed rule by using `DescribeRule` or `ListRules` and
2794
- # checking the `ManagedBy` field of the response.
2850
+ # If this is a managed rule, created by an Amazon Web Services service
2851
+ # on your behalf, you must specify `Force` as `True` to remove targets.
2852
+ # This parameter is ignored for rules that are not managed rules. You
2853
+ # can check whether a rule is a managed rule by using `DescribeRule` or
2854
+ # `ListRules` and checking the `ManagedBy` field of the response.
2795
2855
  #
2796
2856
  # @return [Types::RemoveTargetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2797
2857
  #
@@ -2899,8 +2959,8 @@ module Aws::EventBridge
2899
2959
  # a user permission to access or change only resources with certain tag
2900
2960
  # values. In EventBridge, rules and event buses can be tagged.
2901
2961
  #
2902
- # Tags don't have any semantic meaning to AWS and are interpreted
2903
- # strictly as strings of characters.
2962
+ # Tags don't have any semantic meaning to Amazon Web Services and are
2963
+ # interpreted strictly as strings of characters.
2904
2964
  #
2905
2965
  # You can use the `TagResource` action with a resource that already has
2906
2966
  # tags. If you specify a new tag key, this tag is appended to the list
@@ -2941,11 +3001,11 @@ module Aws::EventBridge
2941
3001
 
2942
3002
  # Tests whether the specified event pattern matches the provided event.
2943
3003
  #
2944
- # Most services in AWS treat : or / as the same character in Amazon
2945
- # Resource Names (ARNs). However, EventBridge uses an exact match in
2946
- # event patterns and rules. Be sure to use the correct ARN characters
2947
- # when creating event patterns so that they match the ARN syntax in the
2948
- # event you want to match.
3004
+ # Most services in Amazon Web Services treat : or / as the same
3005
+ # character in Amazon Resource Names (ARNs). However, EventBridge uses
3006
+ # an exact match in event patterns and rules. Be sure to use the correct
3007
+ # ARN characters when creating event patterns so that they match the ARN
3008
+ # syntax in the event you want to match.
2949
3009
  #
2950
3010
  # @option params [required, String] :event_pattern
2951
3011
  # The event pattern. For more information, see [Events and Event
@@ -2957,8 +3017,8 @@ module Aws::EventBridge
2957
3017
  #
2958
3018
  # @option params [required, String] :event
2959
3019
  # The event, in JSON format, to test against the event pattern. The JSON
2960
- # must follow the format specified in [AWS Events][1], and the following
2961
- # fields are mandatory:
3020
+ # must follow the format specified in [Amazon Web Services Events][1],
3021
+ # and the following fields are mandatory:
2962
3022
  #
2963
3023
  # * `id`
2964
3024
  #
@@ -3255,7 +3315,7 @@ module Aws::EventBridge
3255
3315
  params: params,
3256
3316
  config: config)
3257
3317
  context[:gem_name] = 'aws-sdk-eventbridge'
3258
- context[:gem_version] = '1.27.0'
3318
+ context[:gem_version] = '1.28.0'
3259
3319
  Seahorse::Client::Request.new(handlers, context)
3260
3320
  end
3261
3321
 
@@ -181,7 +181,7 @@ module Aws::EventBridge
181
181
  # The array properties for the submitted job, such as the size of the
182
182
  # array. The array size can be between 2 and 10,000. If you specify
183
183
  # array properties for a job, it becomes an array job. This parameter is
184
- # used only if the target is an AWS Batch job.
184
+ # used only if the target is an Batch job.
185
185
  #
186
186
  # @note When making an API call, you may pass BatchArrayProperties
187
187
  # data as a hash:
@@ -203,7 +203,7 @@ module Aws::EventBridge
203
203
  include Aws::Structure
204
204
  end
205
205
 
206
- # The custom parameters to be used when the target is an AWS Batch job.
206
+ # The custom parameters to be used when the target is an Batch job.
207
207
  #
208
208
  # @note When making an API call, you may pass BatchParameters
209
209
  # data as a hash:
@@ -221,27 +221,27 @@ module Aws::EventBridge
221
221
  #
222
222
  # @!attribute [rw] job_definition
223
223
  # The ARN or name of the job definition to use if the event target is
224
- # an AWS Batch job. This job definition must already exist.
224
+ # an Batch job. This job definition must already exist.
225
225
  # @return [String]
226
226
  #
227
227
  # @!attribute [rw] job_name
228
228
  # The name to use for this execution of the job, if the target is an
229
- # AWS Batch job.
229
+ # Batch job.
230
230
  # @return [String]
231
231
  #
232
232
  # @!attribute [rw] array_properties
233
233
  # The array properties for the submitted job, such as the size of the
234
234
  # array. The array size can be between 2 and 10,000. If you specify
235
235
  # array properties for a job, it becomes an array job. This parameter
236
- # is used only if the target is an AWS Batch job.
236
+ # is used only if the target is an Batch job.
237
237
  # @return [Types::BatchArrayProperties]
238
238
  #
239
239
  # @!attribute [rw] retry_strategy
240
- # The retry strategy to use for failed jobs, if the target is an AWS
241
- # Batch job. The retry strategy is the number of times to retry the
242
- # failed job execution. Valid values are 1–10. When you specify a
243
- # retry strategy here, it overrides the retry strategy defined in the
244
- # job definition.
240
+ # The retry strategy to use for failed jobs, if the target is an Batch
241
+ # job. The retry strategy is the number of times to retry the failed
242
+ # job execution. Valid values are 1–10. When you specify a retry
243
+ # strategy here, it overrides the retry strategy defined in the job
244
+ # definition.
245
245
  # @return [Types::BatchRetryStrategy]
246
246
  #
247
247
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/BatchParameters AWS API Documentation
@@ -255,9 +255,9 @@ module Aws::EventBridge
255
255
  include Aws::Structure
256
256
  end
257
257
 
258
- # The retry strategy to use for failed jobs, if the target is an AWS
259
- # Batch job. If you specify a retry strategy here, it overrides the
260
- # retry strategy defined in the job definition.
258
+ # The retry strategy to use for failed jobs, if the target is an Batch
259
+ # job. If you specify a retry strategy here, it overrides the retry
260
+ # strategy defined in the job definition.
261
261
  #
262
262
  # @note When making an API call, you may pass BatchRetryStrategy
263
263
  # data as a hash:
@@ -373,10 +373,10 @@ module Aws::EventBridge
373
373
 
374
374
  # A JSON string which you can use to limit the event bus permissions you
375
375
  # are granting to only accounts that fulfill the condition. Currently,
376
- # the only supported condition is membership in a certain AWS
377
- # organization. The string must contain `Type`, `Key`, and `Value`
378
- # fields. The `Value` field specifies the ID of the AWS organization.
379
- # Following is an example value for `Condition`\:
376
+ # the only supported condition is membership in a certain Amazon Web
377
+ # Services organization. The string must contain `Type`, `Key`, and
378
+ # `Value` fields. The `Value` field specifies the ID of the Amazon Web
379
+ # Services organization. Following is an example value for `Condition`\:
380
380
  #
381
381
  # `'\{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value":
382
382
  # "o-1234567890"\}'`
@@ -828,7 +828,7 @@ module Aws::EventBridge
828
828
  # @return [String]
829
829
  #
830
830
  # @!attribute [rw] event_source_arn
831
- # The ARN of the event source associated with the archive.
831
+ # The ARN of the event bus that sends events to the archive.
832
832
  # @return [String]
833
833
  #
834
834
  # @!attribute [rw] description
@@ -1332,14 +1332,14 @@ module Aws::EventBridge
1332
1332
  # @!attribute [rw] name
1333
1333
  # The name of the partner event source. This name must be unique and
1334
1334
  # must be in the format ` partner_name/event_namespace/event_name `.
1335
- # The AWS account that wants to use this partner event source must
1336
- # create a partner event bus with a name that matches the name of the
1337
- # partner event source.
1335
+ # The Amazon Web Services account that wants to use this partner event
1336
+ # source must create a partner event bus with a name that matches the
1337
+ # name of the partner event source.
1338
1338
  # @return [String]
1339
1339
  #
1340
1340
  # @!attribute [rw] account
1341
- # The AWS account ID that is permitted to create a matching partner
1342
- # event bus for this partner event source.
1341
+ # The Amazon Web Services account ID that is permitted to create a
1342
+ # matching partner event bus for this partner event source.
1343
1343
  # @return [String]
1344
1344
  #
1345
1345
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreatePartnerEventSourceRequest AWS API Documentation
@@ -1587,8 +1587,8 @@ module Aws::EventBridge
1587
1587
  # @return [String]
1588
1588
  #
1589
1589
  # @!attribute [rw] account
1590
- # The AWS account ID of the AWS customer that the event source was
1591
- # created for.
1590
+ # The Amazon Web Services account ID of the Amazon Web Services
1591
+ # customer that the event source was created for.
1592
1592
  # @return [String]
1593
1593
  #
1594
1594
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeletePartnerEventSourceRequest AWS API Documentation
@@ -1619,11 +1619,12 @@ module Aws::EventBridge
1619
1619
  # @return [String]
1620
1620
  #
1621
1621
  # @!attribute [rw] force
1622
- # If this is a managed rule, created by an AWS service on your behalf,
1623
- # you must specify `Force` as `True` to delete the rule. This
1624
- # parameter is ignored for rules that are not managed rules. You can
1625
- # check whether a rule is a managed rule by using `DescribeRule` or
1626
- # `ListRules` and checking the `ManagedBy` field of the response.
1622
+ # If this is a managed rule, created by an Amazon Web Services service
1623
+ # on your behalf, you must specify `Force` as `True` to delete the
1624
+ # rule. This parameter is ignored for rules that are not managed
1625
+ # rules. You can check whether a rule is a managed rule by using
1626
+ # `DescribeRule` or `ListRules` and checking the `ManagedBy` field of
1627
+ # the response.
1627
1628
  # @return [Boolean]
1628
1629
  #
1629
1630
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteRuleRequest AWS API Documentation
@@ -2176,9 +2177,9 @@ module Aws::EventBridge
2176
2177
  # @return [String]
2177
2178
  #
2178
2179
  # @!attribute [rw] managed_by
2179
- # If this is a managed rule, created by an AWS service on your behalf,
2180
- # this field displays the principal name of the AWS service that
2181
- # created the rule.
2180
+ # If this is a managed rule, created by an Amazon Web Services service
2181
+ # on your behalf, this field displays the principal name of the Amazon
2182
+ # Web Services service that created the rule.
2182
2183
  # @return [String]
2183
2184
  #
2184
2185
  # @!attribute [rw] event_bus_name
@@ -2301,9 +2302,9 @@ module Aws::EventBridge
2301
2302
  # Specifies the launch type on which your task is running. The launch
2302
2303
  # type that you specify here must match one of the launch type
2303
2304
  # (compatibilities) of the target task. The `FARGATE` value is
2304
- # supported only in the Regions where AWS Fargate with Amazon ECS is
2305
- # supported. For more information, see [AWS Fargate on Amazon ECS][1]
2306
- # in the *Amazon Elastic Container Service Developer Guide*.
2305
+ # supported only in the Regions where Fargate witt Amazon ECS is
2306
+ # supported. For more information, see [Fargate on Amazon ECS][1] in
2307
+ # the *Amazon Elastic Container Service Developer Guide*.
2307
2308
  #
2308
2309
  #
2309
2310
  #
@@ -2311,8 +2312,8 @@ module Aws::EventBridge
2311
2312
  # @return [String]
2312
2313
  #
2313
2314
  # @!attribute [rw] network_configuration
2314
- # Use this structure if the ECS task uses the `awsvpc` network mode.
2315
- # This structure specifies the VPC subnets and security groups
2315
+ # Use this structure if the Amazon ECS task uses the `awsvpc` network
2316
+ # mode. This structure specifies the VPC subnets and security groups
2316
2317
  # associated with the task, and whether a public IP address is to be
2317
2318
  # used. This structure is required if `LaunchType` is `FARGATE`
2318
2319
  # because the `awsvpc` mode is required for Fargate tasks.
@@ -2326,7 +2327,7 @@ module Aws::EventBridge
2326
2327
  # numeric portion of the platform version, such as `1.1.0`.
2327
2328
  #
2328
2329
  # This structure is used only if `LaunchType` is `FARGATE`. For more
2329
- # information about valid platform versions, see [AWS Fargate Platform
2330
+ # information about valid platform versions, see [Fargate Platform
2330
2331
  # Versions][1] in the *Amazon Elastic Container Service Developer
2331
2332
  # Guide*.
2332
2333
  #
@@ -2447,10 +2448,11 @@ module Aws::EventBridge
2447
2448
 
2448
2449
  # An event bus receives events from a source and routes them to rules
2449
2450
  # associated with that event bus. Your account's default event bus
2450
- # receives events from AWS services. A custom event bus can receive
2451
- # events from your custom applications and services. A partner event bus
2452
- # receives events from an event source created by an SaaS partner. These
2453
- # events come from the partners services or applications.
2451
+ # receives events from Amazon Web Services services. A custom event bus
2452
+ # can receive events from your custom applications and services. A
2453
+ # partner event bus receives events from an event source created by an
2454
+ # SaaS partner. These events come from the partners services or
2455
+ # applications.
2454
2456
  #
2455
2457
  # @!attribute [rw] name
2456
2458
  # The name of the event bus.
@@ -2461,8 +2463,8 @@ module Aws::EventBridge
2461
2463
  # @return [String]
2462
2464
  #
2463
2465
  # @!attribute [rw] policy
2464
- # The permissions policy of the event bus, describing which other AWS
2465
- # accounts can write events to this event bus.
2466
+ # The permissions policy of the event bus, describing which other
2467
+ # Amazon Web Services accounts can write events to this event bus.
2466
2468
  # @return [String]
2467
2469
  #
2468
2470
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/EventBus AWS API Documentation
@@ -2476,9 +2478,9 @@ module Aws::EventBridge
2476
2478
  end
2477
2479
 
2478
2480
  # A partner event source is created by an SaaS partner. If a customer
2479
- # creates a partner event bus that matches this event source, that AWS
2480
- # account can receive events from the partner's applications or
2481
- # services.
2481
+ # creates a partner event bus that matches this event source, that
2482
+ # Amazon Web Services account can receive events from the partner's
2483
+ # applications or services.
2482
2484
  #
2483
2485
  # @!attribute [rw] arn
2484
2486
  # The ARN of the event source.
@@ -2493,8 +2495,8 @@ module Aws::EventBridge
2493
2495
  # @return [Time]
2494
2496
  #
2495
2497
  # @!attribute [rw] expiration_time
2496
- # The date and time that the event source will expire, if the AWS
2497
- # account doesn't create a matching event bus for it.
2498
+ # The date and time that the event source will expire, if the Amazon
2499
+ # Web Services account doesn't create a matching event bus for it.
2498
2500
  # @return [Time]
2499
2501
  #
2500
2502
  # @!attribute [rw] name
@@ -2595,7 +2597,7 @@ module Aws::EventBridge
2595
2597
  # valid JSON path. You can have as many as 100 key-value pairs. You
2596
2598
  # must use JSON dot notation, not bracket notation.
2597
2599
  #
2598
- # The keys cannot start with "AWS."
2600
+ # The keys cannot start with "Amazon Web Services."
2599
2601
  # @return [Hash<String,String>]
2600
2602
  #
2601
2603
  # @!attribute [rw] input_template
@@ -3133,7 +3135,7 @@ module Aws::EventBridge
3133
3135
  # @return [String]
3134
3136
  #
3135
3137
  # @!attribute [rw] event_source_arn
3136
- # The ARN of the event source associated with the replay.
3138
+ # The ARN of the archive from which the events are replayed.
3137
3139
  # @return [String]
3138
3140
  #
3139
3141
  # @!attribute [rw] next_token
@@ -3379,11 +3381,11 @@ module Aws::EventBridge
3379
3381
  include Aws::Structure
3380
3382
  end
3381
3383
 
3382
- # This rule was created by an AWS service on behalf of your account. It
3383
- # is managed by that service. If you see this error in response to
3384
- # `DeleteRule` or `RemoveTargets`, you can use the `Force` parameter in
3385
- # those calls to delete the rule or remove targets from the rule. You
3386
- # cannot modify these managed rules by using `DisableRule`,
3384
+ # This rule was created by an Amazon Web Services service on behalf of
3385
+ # your account. It is managed by that service. If you see this error in
3386
+ # response to `DeleteRule` or `RemoveTargets`, you can use the `Force`
3387
+ # parameter in those calls to delete the rule or remove targets from the
3388
+ # rule. You cannot modify these managed rules by using `DisableRule`,
3387
3389
  # `EnableRule`, `PutTargets`, `PutRule`, `TagResource`, or
3388
3390
  # `UntagResource`.
3389
3391
  #
@@ -3426,9 +3428,9 @@ module Aws::EventBridge
3426
3428
  class OperationDisabledException < Aws::EmptyStructure; end
3427
3429
 
3428
3430
  # A partner event source is created by an SaaS partner. If a customer
3429
- # creates a partner event bus that matches this event source, that AWS
3430
- # account can receive events from the partner's applications or
3431
- # services.
3431
+ # creates a partner event bus that matches this event source, that
3432
+ # Amazon Web Services account can receive events from the partner's
3433
+ # applications or services.
3432
3434
  #
3433
3435
  # @!attribute [rw] arn
3434
3436
  # The ARN of the partner event source.
@@ -3447,10 +3449,12 @@ module Aws::EventBridge
3447
3449
  include Aws::Structure
3448
3450
  end
3449
3451
 
3450
- # The AWS account that a partner event source has been offered to.
3452
+ # The Amazon Web Services account that a partner event source has been
3453
+ # offered to.
3451
3454
  #
3452
3455
  # @!attribute [rw] account
3453
- # The AWS account ID that the partner event source was offered to.
3456
+ # The Amazon Web Services account ID that the partner event source was
3457
+ # offered to.
3454
3458
  # @return [String]
3455
3459
  #
3456
3460
  # @!attribute [rw] creation_time
@@ -3458,8 +3462,8 @@ module Aws::EventBridge
3458
3462
  # @return [Time]
3459
3463
  #
3460
3464
  # @!attribute [rw] expiration_time
3461
- # The date and time that the event source will expire, if the AWS
3462
- # account doesn't create a matching event bus for it.
3465
+ # The date and time that the event source will expire, if the Amazon
3466
+ # Web Services account doesn't create a matching event bus for it.
3463
3467
  # @return [Time]
3464
3468
  #
3465
3469
  # @!attribute [rw] state
@@ -3527,7 +3531,7 @@ module Aws::EventBridge
3527
3531
 
3528
3532
  # The task placement strategy for a task or service. To learn more, see
3529
3533
  # [Task Placement Strategies][1] in the Amazon Elastic Container Service
3530
- # Developer Guide.
3534
+ # Service Developer Guide.
3531
3535
  #
3532
3536
  #
3533
3537
  #
@@ -3626,11 +3630,12 @@ module Aws::EventBridge
3626
3630
  #
3627
3631
  # @!attribute [rw] time
3628
3632
  # The time stamp of the event, per [RFC3339][1]. If no time stamp is
3629
- # provided, the time stamp of the PutEvents call is used.
3633
+ # provided, the time stamp of the [PutEvents][2] call is used.
3630
3634
  #
3631
3635
  #
3632
3636
  #
3633
3637
  # [1]: https://www.rfc-editor.org/rfc/rfc3339.txt
3638
+ # [2]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html
3634
3639
  # @return [Time]
3635
3640
  #
3636
3641
  # @!attribute [rw] source
@@ -3638,9 +3643,9 @@ module Aws::EventBridge
3638
3643
  # @return [String]
3639
3644
  #
3640
3645
  # @!attribute [rw] resources
3641
- # AWS resources, identified by Amazon Resource Name (ARN), which the
3642
- # event primarily concerns. Any number, including zero, may be
3643
- # present.
3646
+ # Amazon Web Services resources, identified by Amazon Resource Name
3647
+ # (ARN), which the event primarily concerns. Any number, including
3648
+ # zero, may be present.
3644
3649
  # @return [Array<String>]
3645
3650
  #
3646
3651
  # @!attribute [rw] detail_type
@@ -3660,11 +3665,11 @@ module Aws::EventBridge
3660
3665
  # @return [String]
3661
3666
  #
3662
3667
  # @!attribute [rw] trace_header
3663
- # An AWS X-Ray trade header, which is an http header (X-Amzn-Trace-Id)
3668
+ # An X-Ray trade header, which is an http header (X-Amzn-Trace-Id)
3664
3669
  # that contains the trace-id associated with the event.
3665
3670
  #
3666
3671
  # To learn more about X-Ray trace headers, see [Tracing header][1] in
3667
- # the AWS X-Ray Developer Guide.
3672
+ # the X-Ray Developer Guide.
3668
3673
  #
3669
3674
  #
3670
3675
  #
@@ -3774,13 +3779,13 @@ module Aws::EventBridge
3774
3779
  # @return [Time]
3775
3780
  #
3776
3781
  # @!attribute [rw] source
3777
- # The event source that is generating the evntry.
3782
+ # The event source that is generating the entry.
3778
3783
  # @return [String]
3779
3784
  #
3780
3785
  # @!attribute [rw] resources
3781
- # AWS resources, identified by Amazon Resource Name (ARN), which the
3782
- # event primarily concerns. Any number, including zero, may be
3783
- # present.
3786
+ # Amazon Web Services resources, identified by Amazon Resource Name
3787
+ # (ARN), which the event primarily concerns. Any number, including
3788
+ # zero, may be present.
3784
3789
  # @return [Array<String>]
3785
3790
  #
3786
3791
  # @!attribute [rw] detail_type
@@ -3871,13 +3876,12 @@ module Aws::EventBridge
3871
3876
  #
3872
3877
  # @!attribute [rw] action
3873
3878
  # The action that you are enabling the other account to perform.
3874
- # Currently, this must be `events:PutEvents`.
3875
3879
  # @return [String]
3876
3880
  #
3877
3881
  # @!attribute [rw] principal
3878
- # The 12-digit AWS account ID that you are permitting to put events to
3879
- # your default event bus. Specify "*" to permit any account to put
3880
- # events to your default event bus.
3882
+ # The 12-digit Amazon Web Services account ID that you are permitting
3883
+ # to put events to your default event bus. Specify "*" to permit
3884
+ # any account to put events to your default event bus.
3881
3885
  #
3882
3886
  # If you specify "*" without specifying `Condition`, avoid creating
3883
3887
  # rules that may match undesirable events. To create more secure
@@ -3891,19 +3895,24 @@ module Aws::EventBridge
3891
3895
  # An identifier string for the external account that you are granting
3892
3896
  # permissions to. If you later want to revoke the permission for this
3893
3897
  # external account, specify this `StatementId` when you run
3894
- # RemovePermission.
3898
+ # [RemovePermission][1].
3899
+ #
3900
+ #
3901
+ #
3902
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html
3895
3903
  # @return [String]
3896
3904
  #
3897
3905
  # @!attribute [rw] condition
3898
3906
  # This parameter enables you to limit the permission to accounts that
3899
- # fulfill a certain condition, such as being a member of a certain AWS
3900
- # organization. For more information about AWS Organizations, see
3901
- # [What Is AWS Organizations][1] in the *AWS Organizations User
3907
+ # fulfill a certain condition, such as being a member of a certain
3908
+ # Amazon Web Services organization. For more information about Amazon
3909
+ # Web Services Organizations, see [What Is Amazon Web Services
3910
+ # Organizations][1] in the *Amazon Web Services Organizations User
3902
3911
  # Guide*.
3903
3912
  #
3904
- # If you specify `Condition` with an AWS organization ID, and specify
3905
- # "*" as the value for `Principal`, you grant permission to all the
3906
- # accounts in the named organization.
3913
+ # If you specify `Condition` with an Amazon Web Services organization
3914
+ # ID, and specify "*" as the value for `Principal`, you grant
3915
+ # permission to all the accounts in the named organization.
3907
3916
  #
3908
3917
  # The `Condition` is a JSON string which must contain `Type`, `Key`,
3909
3918
  # and `Value` fields.
@@ -3980,6 +3989,12 @@ module Aws::EventBridge
3980
3989
  # @!attribute [rw] role_arn
3981
3990
  # The Amazon Resource Name (ARN) of the IAM role associated with the
3982
3991
  # rule.
3992
+ #
3993
+ # If you're setting an event bus in another account as the target and
3994
+ # that account granted permission to your account through an
3995
+ # organization instead of directly by the account ID, you must specify
3996
+ # a `RoleArn` with proper permissions in the `Target` structure,
3997
+ # instead of here in this parameter.
3983
3998
  # @return [String]
3984
3999
  #
3985
4000
  # @!attribute [rw] tags
@@ -4206,9 +4221,9 @@ module Aws::EventBridge
4206
4221
  include Aws::Structure
4207
4222
  end
4208
4223
 
4209
- # These are custom parameters to be used when the target is a Redshift
4210
- # cluster to invoke the Redshift Data API ExecuteStatement based on
4211
- # EventBridge events.
4224
+ # These are custom parameters to be used when the target is a Amazon
4225
+ # Redshift cluster to invoke the Amazon Redshift Data API
4226
+ # ExecuteStatement based on EventBridge events.
4212
4227
  #
4213
4228
  # @note When making an API call, you may pass RedshiftDataParameters
4214
4229
  # data as a hash:
@@ -4224,7 +4239,8 @@ module Aws::EventBridge
4224
4239
  #
4225
4240
  # @!attribute [rw] secret_manager_arn
4226
4241
  # The name or ARN of the secret that enables access to the database.
4227
- # Required when authenticating using AWS Secrets Manager.
4242
+ # Required when authenticating using Amazon Web Services Secrets
4243
+ # Manager.
4228
4244
  # @return [String]
4229
4245
  #
4230
4246
  # @!attribute [rw] database
@@ -4321,11 +4337,12 @@ module Aws::EventBridge
4321
4337
  # @return [Array<String>]
4322
4338
  #
4323
4339
  # @!attribute [rw] force
4324
- # If this is a managed rule, created by an AWS service on your behalf,
4325
- # you must specify `Force` as `True` to remove targets. This parameter
4326
- # is ignored for rules that are not managed rules. You can check
4327
- # whether a rule is a managed rule by using `DescribeRule` or
4328
- # `ListRules` and checking the `ManagedBy` field of the response.
4340
+ # If this is a managed rule, created by an Amazon Web Services service
4341
+ # on your behalf, you must specify `Force` as `True` to remove
4342
+ # targets. This parameter is ignored for rules that are not managed
4343
+ # rules. You can check whether a rule is a managed rule by using
4344
+ # `DescribeRule` or `ListRules` and checking the `ManagedBy` field of
4345
+ # the response.
4329
4346
  # @return [Boolean]
4330
4347
  #
4331
4348
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/RemoveTargetsRequest AWS API Documentation
@@ -4543,18 +4560,29 @@ module Aws::EventBridge
4543
4560
  #
4544
4561
  # @!attribute [rw] schedule_expression
4545
4562
  # The scheduling expression. For example, "cron(0 20 * * ? *)",
4546
- # "rate(5 minutes)".
4563
+ # "rate(5 minutes)". For more information, see [Creating an Amazon
4564
+ # EventBridge rule that runs on a schedule][1].
4565
+ #
4566
+ #
4567
+ #
4568
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html
4547
4569
  # @return [String]
4548
4570
  #
4549
4571
  # @!attribute [rw] role_arn
4550
4572
  # The Amazon Resource Name (ARN) of the role that is used for target
4551
4573
  # invocation.
4574
+ #
4575
+ # If you're setting an event bus in another account as the target and
4576
+ # that account granted permission to your account through an
4577
+ # organization instead of directly by the account ID, you must specify
4578
+ # a `RoleArn` with proper permissions in the `Target` structure,
4579
+ # instead of here in this parameter.
4552
4580
  # @return [String]
4553
4581
  #
4554
4582
  # @!attribute [rw] managed_by
4555
- # If the rule was created on behalf of your account by an AWS service,
4556
- # this field displays the principal name of the service that created
4557
- # the rule.
4583
+ # If the rule was created on behalf of your account by an Amazon Web
4584
+ # Services service, this field displays the principal name of the
4585
+ # service that created the rule.
4558
4586
  # @return [String]
4559
4587
  #
4560
4588
  # @!attribute [rw] event_bus_name
@@ -4801,8 +4829,8 @@ module Aws::EventBridge
4801
4829
  include Aws::Structure
4802
4830
  end
4803
4831
 
4804
- # A key-value pair associated with an AWS resource. In EventBridge,
4805
- # rules and event buses support tagging.
4832
+ # A key-value pair associated with an Amazon Web Services resource. In
4833
+ # EventBridge, rules and event buses support tagging.
4806
4834
  #
4807
4835
  # @note When making an API call, you may pass Tag
4808
4836
  # data as a hash:
@@ -4866,18 +4894,19 @@ module Aws::EventBridge
4866
4894
 
4867
4895
  # Targets are the resources to be invoked when a rule is triggered. For
4868
4896
  # a complete list of services and resources that can be set as a target,
4869
- # see PutTargets.
4897
+ # see [PutTargets][1].
4870
4898
  #
4871
4899
  # If you are setting the event bus of another account as the target, and
4872
4900
  # that account granted permission to your account through an
4873
4901
  # organization instead of directly by the account ID, then you must
4874
4902
  # specify a `RoleArn` with proper permissions in the `Target` structure.
4875
- # For more information, see [Sending and Receiving Events Between AWS
4876
- # Accounts][1] in the *Amazon EventBridge User Guide*.
4903
+ # For more information, see [Sending and Receiving Events Between Amazon
4904
+ # Web Services Accounts][2] in the *Amazon EventBridge User Guide*.
4877
4905
  #
4878
4906
  #
4879
4907
  #
4880
- # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
4908
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html
4909
+ # [2]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
4881
4910
  #
4882
4911
  # @note When making an API call, you may pass Target
4883
4912
  # data as a hash:
@@ -4996,7 +5025,8 @@ module Aws::EventBridge
4996
5025
  # }
4997
5026
  #
4998
5027
  # @!attribute [rw] id
4999
- # The ID of the target.
5028
+ # The ID of the target. We recommend using a memorable and unique
5029
+ # string.
5000
5030
  # @return [String]
5001
5031
  #
5002
5032
  # @!attribute [rw] arn
@@ -5060,9 +5090,9 @@ module Aws::EventBridge
5060
5090
  # @return [Types::EcsParameters]
5061
5091
  #
5062
5092
  # @!attribute [rw] batch_parameters
5063
- # If the event target is an AWS Batch job, this contains the job
5093
+ # If the event target is an Batch job, this contains the job
5064
5094
  # definition, job name, and other parameters. For more information,
5065
- # see [Jobs][1] in the *AWS Batch User Guide*.
5095
+ # see [Jobs][1] in the *Batch User Guide*.
5066
5096
  #
5067
5097
  #
5068
5098
  #
@@ -5091,12 +5121,12 @@ module Aws::EventBridge
5091
5121
  # @return [Types::HttpParameters]
5092
5122
  #
5093
5123
  # @!attribute [rw] redshift_data_parameters
5094
- # Contains the Redshift Data API parameters to use when the target is
5095
- # a Redshift cluster.
5124
+ # Contains the Amazon Redshift Data API parameters to use when the
5125
+ # target is a Amazon Redshift cluster.
5096
5126
  #
5097
- # If you specify a Redshift Cluster as a Target, you can use this to
5098
- # specify parameters to invoke the Redshift Data API ExecuteStatement
5099
- # based on EventBridge events.
5127
+ # If you specify a Amazon Redshift Cluster as a Target, you can use
5128
+ # this to specify parameters to invoke the Amazon Redshift Data API
5129
+ # ExecuteStatement based on EventBridge events.
5100
5130
  # @return [Types::RedshiftDataParameters]
5101
5131
  #
5102
5132
  # @!attribute [rw] sage_maker_pipeline_parameters
@@ -5160,8 +5190,8 @@ module Aws::EventBridge
5160
5190
  #
5161
5191
  # @!attribute [rw] event
5162
5192
  # The event, in JSON format, to test against the event pattern. The
5163
- # JSON must follow the format specified in [AWS Events][1], and the
5164
- # following fields are mandatory:
5193
+ # JSON must follow the format specified in [Amazon Web Services
5194
+ # Events][1], and the following fields are mandatory:
5165
5195
  #
5166
5196
  # * `id`
5167
5197
  #
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-eventbridge
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.27.0
4
+ version: 1.28.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-07-30 00:00:00.000000000 Z
11
+ date: 2021-08-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core