aws-sdk-cloudwatchevents 1.25.0 → 1.26.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 74dd97c573b6a31ca86a57af8723e57532a948d5
4
- data.tar.gz: d41ad6c95929caaf88752a1644ec647ffa328908
3
+ metadata.gz: c176eaf0d141297b0ad76bb878a7cd40dffa8251
4
+ data.tar.gz: d316ea92ae6de382234416ffb2ca9f80db14c1ff
5
5
  SHA512:
6
- metadata.gz: 44140c0771d64a8717b23cfd8d843011439ba7ba58233741c2a1a8b58012bc49ef00c8b90dc4956a9dd1eb3ba96290c32423e3ab854f170a4c20830a7deff2e3
7
- data.tar.gz: 3436e5ec13bf4deb5f1bc8c6df20a00fd0224e0dccf87a9c472e53f9ccc7ee5cbb4c2cd3bb140c6d50bd795363645892478b011cee8d4b8e9c3ca6e0edcec35c
6
+ metadata.gz: 5c47850ef9ad680664251488cd392bd31f16f37768ddbb2dad25fbd32df5f17d6925e5efce453d4b08364a983e81ce4bdf9dba2b9500f32c31ceedc1c209da3f
7
+ data.tar.gz: d7d6542082c55b76390280f54f755221ea83d6def1e4e31907be1db554632897291892ee5bc2074c64bec9e6f6f66f67ef0853381d8c5ec51120789ad366acb9
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-cloudwatchevents/customizations'
42
42
  # @service
43
43
  module Aws::CloudWatchEvents
44
44
 
45
- GEM_VERSION = '1.25.0'
45
+ GEM_VERSION = '1.26.0'
46
46
 
47
47
  end
@@ -268,10 +268,6 @@ module Aws::CloudWatchEvents
268
268
  # activated, your matching event bus will start receiving events from
269
269
  # the event source.
270
270
  #
271
- # <note markdown="1"> This operation is performed by AWS customers, not by SaaS partners.
272
- #
273
- # </note>
274
- #
275
271
  # @option params [required, String] :name
276
272
  # The name of the partner event source to activate.
277
273
  #
@@ -293,29 +289,27 @@ module Aws::CloudWatchEvents
293
289
  end
294
290
 
295
291
  # Creates a new event bus within your account. This can be a custom
296
- # event bus which you can use to receive events from your own custom
292
+ # event bus which you can use to receive events from your custom
297
293
  # applications and services, or it can be a partner event bus which can
298
294
  # be matched to a partner event source.
299
295
  #
300
- # <note markdown="1"> This operation is used by AWS customers, not by SaaS partners.
301
- #
302
- # </note>
303
- #
304
296
  # @option params [required, String] :name
305
297
  # The name of the new event bus.
306
298
  #
307
- # The names of custom event buses can't contain the `/` character. You
308
- # can't use the name `default` for a custom event bus because this name
309
- # is already used for your account's default event bus.
299
+ # Event bus names cannot contain the / character. You can't use the
300
+ # name `default` for a custom event bus, as this name is already used
301
+ # for your account's default event bus.
310
302
  #
311
303
  # If this is a partner event bus, the name must exactly match the name
312
- # of the partner event source that this event bus is matched to. This
313
- # name will include the `/` character.
304
+ # of the partner event source that this event bus is matched to.
314
305
  #
315
306
  # @option params [String] :event_source_name
316
- # If you're creating a partner event bus, this specifies the partner
307
+ # If you are creating a partner event bus, this specifies the partner
317
308
  # event source that the new event bus will be matched with.
318
309
  #
310
+ # @option params [Array<Types::Tag>] :tags
311
+ # Tags to associate with the event bus.
312
+ #
319
313
  # @return [Types::CreateEventBusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
320
314
  #
321
315
  # * {Types::CreateEventBusResponse#event_bus_arn #event_bus_arn} => String
@@ -325,6 +319,12 @@ module Aws::CloudWatchEvents
325
319
  # resp = client.create_event_bus({
326
320
  # name: "EventBusName", # required
327
321
  # event_source_name: "EventSourceName",
322
+ # tags: [
323
+ # {
324
+ # key: "TagKey", # required
325
+ # value: "TagValue", # required
326
+ # },
327
+ # ],
328
328
  # })
329
329
  #
330
330
  # @example Response structure
@@ -340,19 +340,16 @@ module Aws::CloudWatchEvents
340
340
  req.send_request(options)
341
341
  end
342
342
 
343
- # Called by an SaaS partner to create a partner event source.
344
- #
345
- # <note markdown="1"> This operation is not used by AWS customers.
346
- #
347
- # </note>
343
+ # Called by an SaaS partner to create a partner event source. This
344
+ # operation is not used by AWS customers.
348
345
  #
349
346
  # Each partner event source can be used by one AWS account to create a
350
347
  # matching partner event bus in that AWS account. A SaaS partner must
351
348
  # create one partner event source for each AWS account that wants to
352
349
  # receive those event types.
353
350
  #
354
- # A partner event source creates events based on resources in the SaaS
355
- # partner's service or application.
351
+ # A partner event source creates events based on resources within the
352
+ # SaaS partner's service or application.
356
353
  #
357
354
  # An AWS account that creates a partner event bus that matches the
358
355
  # partner event source can use that event bus to receive events from the
@@ -360,19 +357,16 @@ module Aws::CloudWatchEvents
360
357
  #
361
358
  # Partner event source names follow this format:
362
359
  #
363
- # `aws.partner/partner_name/event_namespace/event_name `
364
- #
365
- # * *partner\_name* is determined during partner registration and
366
- # identifies the partner to AWS customers.
360
+ # ` partner_name/event_namespace/event_name `
367
361
  #
368
- # * For *event\_namespace*, we recommend that partners use a string that
369
- # identifies the AWS customer within the partner's system. This
370
- # should not be the customer's AWS account ID.
371
- #
372
- # * *event\_name* is determined by the partner, and should uniquely
373
- # identify an event-generating resource within the partner system.
374
- # This should help AWS customers decide whether to create an event bus
375
- # to receive these events.
362
+ # *partner\_name* is determined during partner registration and
363
+ # identifies the partner to AWS customers. *event\_namespace* is
364
+ # determined by the partner and is a way for the partner to categorize
365
+ # their events. *event\_name* is determined by the partner, and should
366
+ # uniquely identify an event-generating resource within the partner
367
+ # system. The combination of *event\_namespace* and *event\_name* should
368
+ # help AWS customers decide whether to create an event bus to receive
369
+ # these events.
376
370
  #
377
371
  # @option params [required, String] :name
378
372
  # The name of the partner event source. This name must be unique and
@@ -382,8 +376,8 @@ module Aws::CloudWatchEvents
382
376
  # event source.
383
377
  #
384
378
  # @option params [required, String] :account
385
- # The AWS account ID of the customer who is permitted to create a
386
- # matching partner event bus for this partner event source.
379
+ # The AWS account ID that is permitted to create a matching partner
380
+ # event bus for this partner event source.
387
381
  #
388
382
  # @return [Types::CreatePartnerEventSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
389
383
  #
@@ -409,13 +403,13 @@ module Aws::CloudWatchEvents
409
403
  req.send_request(options)
410
404
  end
411
405
 
412
- # An AWS customer uses this operation to temporarily stop receiving
413
- # events from the specified partner event source. The matching event bus
414
- # isn't deleted.
406
+ # You can use this operation to temporarily stop receiving events from
407
+ # the specified partner event source. The matching event bus is not
408
+ # deleted.
415
409
  #
416
410
  # When you deactivate a partner event source, the source goes into
417
- # `PENDING` state. If it remains in `PENDING` state for more than two
418
- # weeks, it's deleted.
411
+ # PENDING state. If it remains in PENDING state for more than two weeks,
412
+ # it is deleted.
419
413
  #
420
414
  # To activate a deactivated partner event source, use
421
415
  # ActivateEventSource.
@@ -441,13 +435,9 @@ module Aws::CloudWatchEvents
441
435
  end
442
436
 
443
437
  # Deletes the specified custom event bus or partner event bus. All rules
444
- # associated with this event bus are also deleted. You can't delete
438
+ # associated with this event bus need to be deleted. You can't delete
445
439
  # your account's default event bus.
446
440
  #
447
- # <note markdown="1"> This operation is performed by AWS customers, not by SaaS partners.
448
- #
449
- # </note>
450
- #
451
441
  # @option params [required, String] :name
452
442
  # The name of the event bus to delete.
453
443
  #
@@ -469,10 +459,10 @@ module Aws::CloudWatchEvents
469
459
  end
470
460
 
471
461
  # This operation is used by SaaS partners to delete a partner event
472
- # source. AWS customers don't use this operation.
462
+ # source. This operation is not used by AWS customers.
473
463
  #
474
464
  # When you delete an event source, the status of the corresponding
475
- # partner event bus in the AWS customer account becomes `DELETED`.
465
+ # partner event bus in the AWS customer account becomes DELETED.
476
466
  #
477
467
  # @option params [required, String] :name
478
468
  # The name of the event source to delete.
@@ -510,8 +500,8 @@ module Aws::CloudWatchEvents
510
500
  # Managed rules are rules created and managed by another AWS service on
511
501
  # your behalf. These rules are created by those other AWS services to
512
502
  # support functionality in those services. You can delete these rules
513
- # using the `Force` option, but you should do so only if you're sure
514
- # that the other service isn't still using that rule.
503
+ # using the `Force` option, but you should do so only if you are sure
504
+ # the other service is not still using that rule.
515
505
  #
516
506
  # @option params [required, String] :name
517
507
  # The name of the rule.
@@ -591,10 +581,6 @@ module Aws::CloudWatchEvents
591
581
  # This operation lists details about a partner event source that is
592
582
  # shared with your account.
593
583
  #
594
- # <note markdown="1"> This operation is run by AWS customers, not by SaaS partners.
595
- #
596
- # </note>
597
- #
598
584
  # @option params [required, String] :name
599
585
  # The name of the partner event source to display the details of.
600
586
  #
@@ -632,13 +618,9 @@ module Aws::CloudWatchEvents
632
618
  end
633
619
 
634
620
  # An SaaS partner can use this operation to list details about a partner
635
- # event source that they have created.
636
- #
637
- # <note markdown="1"> AWS customers do not use this operation. Instead, AWS customers can
638
- # use DescribeEventSource to see details about a partner event source
639
- # that is shared with them.
640
- #
641
- # </note>
621
+ # event source that they have created. AWS customers do not use this
622
+ # operation. Instead, AWS customers can use DescribeEventSource to see
623
+ # details about a partner event source that is shared with them.
642
624
  #
643
625
  # @option params [required, String] :name
644
626
  # The name of the event source to display.
@@ -670,7 +652,7 @@ module Aws::CloudWatchEvents
670
652
 
671
653
  # Describes the specified rule.
672
654
  #
673
- # `DescribeRule` doesn't list the targets of a rule. To see the targets
655
+ # DescribeRule does not list the targets of a rule. To see the targets
674
656
  # associated with a rule, use ListTargetsByRule.
675
657
  #
676
658
  # @option params [required, String] :name
@@ -720,7 +702,7 @@ module Aws::CloudWatchEvents
720
702
  req.send_request(options)
721
703
  end
722
704
 
723
- # Disables the specified rule. A disabled rule won't match any events
705
+ # Disables the specified rule. A disabled rule won't match any events,
724
706
  # and won't self-trigger if it has a schedule expression.
725
707
  #
726
708
  # When you disable a rule, incoming events might continue to match to
@@ -752,7 +734,7 @@ module Aws::CloudWatchEvents
752
734
  req.send_request(options)
753
735
  end
754
736
 
755
- # Enables the specified rule. If the rule doesn't exist, the operation
737
+ # Enables the specified rule. If the rule does not exist, the operation
756
738
  # fails.
757
739
  #
758
740
  # When you enable a rule, incoming events might not immediately start
@@ -787,10 +769,6 @@ module Aws::CloudWatchEvents
787
769
  # Lists all the event buses in your account, including the default event
788
770
  # bus, custom event buses, and partner event buses.
789
771
  #
790
- # <note markdown="1"> This operation is run by AWS customers, not by SaaS partners.
791
- #
792
- # </note>
793
- #
794
772
  # @option params [String] :name_prefix
795
773
  # Specifying this limits the results to only those event buses with
796
774
  # names that start with the specified prefix.
@@ -801,8 +779,8 @@ module Aws::CloudWatchEvents
801
779
  #
802
780
  # @option params [Integer] :limit
803
781
  # Specifying this limits the number of results returned by this
804
- # operation. The operation also returns a `NextToken` that you can use
805
- # in a subsequent operation to retrieve the next set of results.
782
+ # operation. The operation also returns a NextToken which you can use in
783
+ # a subsequent operation to retrieve the next set of results.
806
784
  #
807
785
  # @return [Types::ListEventBusesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
808
786
  #
@@ -838,10 +816,6 @@ module Aws::CloudWatchEvents
838
816
  # shared with your AWS account. For more information about partner event
839
817
  # sources, see CreateEventBus.
840
818
  #
841
- # <note markdown="1"> This operation is run by AWS customers, not by SaaS partners.
842
- #
843
- # </note>
844
- #
845
819
  # @option params [String] :name_prefix
846
820
  # Specifying this limits the results to only those partner event sources
847
821
  # with names that start with the specified prefix.
@@ -852,8 +826,8 @@ module Aws::CloudWatchEvents
852
826
  #
853
827
  # @option params [Integer] :limit
854
828
  # Specifying this limits the number of results returned by this
855
- # operation. The operation also returns a `NextToken` that you can use
856
- # in a subsequent operation to retrieve the next set of results.
829
+ # operation. The operation also returns a NextToken which you can use in
830
+ # a subsequent operation to retrieve the next set of results.
857
831
  #
858
832
  # @return [Types::ListEventSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
859
833
  #
@@ -889,11 +863,8 @@ module Aws::CloudWatchEvents
889
863
  end
890
864
 
891
865
  # An SaaS partner can use this operation to display the AWS account ID
892
- # that a particular partner event source name is associated with.
893
- #
894
- # <note markdown="1"> This operation is used by SaaS partners, not by AWS customers.
895
- #
896
- # </note>
866
+ # that a particular partner event source name is associated with. This
867
+ # operation is not used by AWS customers.
897
868
  #
898
869
  # @option params [required, String] :event_source_name
899
870
  # The name of the partner event source to display account information
@@ -905,8 +876,8 @@ module Aws::CloudWatchEvents
905
876
  #
906
877
  # @option params [Integer] :limit
907
878
  # Specifying this limits the number of results returned by this
908
- # operation. The operation also returns a `NextToken` that you can use
909
- # in a subsequent operation to retrieve the next set of results.
879
+ # operation. The operation also returns a NextToken which you can use in
880
+ # a subsequent operation to retrieve the next set of results.
910
881
  #
911
882
  # @return [Types::ListPartnerEventSourceAccountsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
912
883
  #
@@ -940,11 +911,8 @@ module Aws::CloudWatchEvents
940
911
  end
941
912
 
942
913
  # An SaaS partner can use this operation to list all the partner event
943
- # source names that they have created.
944
- #
945
- # <note markdown="1"> This operation is not used by AWS customers.
946
- #
947
- # </note>
914
+ # source names that they have created. This operation is not used by AWS
915
+ # customers.
948
916
  #
949
917
  # @option params [required, String] :name_prefix
950
918
  # If you specify this, the results are limited to only those partner
@@ -956,8 +924,8 @@ module Aws::CloudWatchEvents
956
924
  #
957
925
  # @option params [Integer] :limit
958
926
  # pecifying this limits the number of results returned by this
959
- # operation. The operation also returns a `NextToken` that you can use
960
- # in a subsequent operation to retrieve the next set of results.
927
+ # operation. The operation also returns a NextToken which you can use in
928
+ # a subsequent operation to retrieve the next set of results.
961
929
  #
962
930
  # @return [Types::ListPartnerEventSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
963
931
  #
@@ -988,8 +956,9 @@ module Aws::CloudWatchEvents
988
956
  req.send_request(options)
989
957
  end
990
958
 
991
- # Lists the rules for the specified target. You can see which rules can
992
- # invoke a specific target in your account.
959
+ # Lists the rules for the specified target. You can see which of the
960
+ # rules in Amazon EventBridge can invoke a specific target in your
961
+ # account.
993
962
  #
994
963
  # @option params [required, String] :target_arn
995
964
  # The Amazon Resource Name (ARN) of the target resource.
@@ -1034,10 +1003,10 @@ module Aws::CloudWatchEvents
1034
1003
  req.send_request(options)
1035
1004
  end
1036
1005
 
1037
- # Lists your EventBridge rules. You can either list all the rules or
1038
- # provide a prefix to match to the rule names.
1006
+ # Lists your Amazon EventBridge rules. You can either list all the rules
1007
+ # or you can provide a prefix to match to the rule names.
1039
1008
  #
1040
- # `ListRules` doesn't list the targets of a rule. To see the targets
1009
+ # ListRules does not list the targets of a rule. To see the targets
1041
1010
  # associated with a rule, use ListTargetsByRule.
1042
1011
  #
1043
1012
  # @option params [String] :name_prefix
@@ -1092,10 +1061,10 @@ module Aws::CloudWatchEvents
1092
1061
  end
1093
1062
 
1094
1063
  # Displays the tags associated with an EventBridge resource. In
1095
- # EventBridge, rules can be tagged.
1064
+ # EventBridge, rules and event buses can be tagged.
1096
1065
  #
1097
1066
  # @option params [required, String] :resource_arn
1098
- # The ARN of the rule for which you want to view tags.
1067
+ # The ARN of the EventBridge resource for which you want to view tags.
1099
1068
  #
1100
1069
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1101
1070
  #
@@ -1194,8 +1163,8 @@ module Aws::CloudWatchEvents
1194
1163
  req.send_request(options)
1195
1164
  end
1196
1165
 
1197
- # Sends custom events to EventBridge so that they can be matched to
1198
- # rules. These events can be from your custom applications and services.
1166
+ # Sends custom events to Amazon EventBridge so that they can be matched
1167
+ # to rules.
1199
1168
  #
1200
1169
  # @option params [required, Array<Types::PutEventsRequestEntry>] :entries
1201
1170
  # The entry that defines an event in your system. You can specify
@@ -1240,13 +1209,7 @@ module Aws::CloudWatchEvents
1240
1209
  end
1241
1210
 
1242
1211
  # This is used by SaaS partners to write events to a customer's partner
1243
- # event bus.
1244
- #
1245
- # <note markdown="1"> AWS customers do not use this operation. Instead, AWS customers can
1246
- # use PutEvents to write custom events from their own applications to an
1247
- # event bus.
1248
- #
1249
- # </note>
1212
+ # event bus. AWS customers do not use this operation.
1250
1213
  #
1251
1214
  # @option params [required, Array<Types::PutPartnerEventsRequestEntry>] :entries
1252
1215
  # The list of events to write to the event bus.
@@ -1262,7 +1225,7 @@ module Aws::CloudWatchEvents
1262
1225
  # entries: [ # required
1263
1226
  # {
1264
1227
  # time: Time.now,
1265
- # source: "String",
1228
+ # source: "EventSourceName",
1266
1229
  # resources: ["EventResource"],
1267
1230
  # detail_type: "String",
1268
1231
  # detail: "String",
@@ -1288,14 +1251,15 @@ module Aws::CloudWatchEvents
1288
1251
  end
1289
1252
 
1290
1253
  # Running `PutPermission` permits the specified AWS account or AWS
1291
- # organization to put events to the specified *event bus*. Rules in your
1292
- # account are triggered by these events arriving to an event bus in your
1293
- # account.
1254
+ # organization to put events to the specified *event bus*. CloudWatch
1255
+ # Events rules in your account are triggered by these events arriving to
1256
+ # an event bus in your account.
1294
1257
  #
1295
1258
  # For another account to send events to your account, that external
1296
- # account must have a rule with your account's event bus as a target.
1259
+ # account must have an EventBridge rule with your account's event bus
1260
+ # as a target.
1297
1261
  #
1298
- # To enable multiple AWS accounts to put events to an event bus, run
1262
+ # To enable multiple AWS accounts to put events to your event bus, run
1299
1263
  # `PutPermission` once for each of these accounts. Or, if all the
1300
1264
  # accounts are members of the same AWS organization, you can run
1301
1265
  # `PutPermission` once specifying `Principal` as "*" and specifying
@@ -1308,7 +1272,8 @@ module Aws::CloudWatchEvents
1308
1272
  # more information, see [Sending and Receiving Events Between AWS
1309
1273
  # Accounts][1] in the *Amazon EventBridge User Guide*.
1310
1274
  #
1311
- # The permission policy on an event bus can't exceed 10 KB in size.
1275
+ # The permission policy on the default event bus cannot exceed 10 KB in
1276
+ # size.
1312
1277
  #
1313
1278
  #
1314
1279
  #
@@ -1319,7 +1284,7 @@ module Aws::CloudWatchEvents
1319
1284
  # event bus is used.
1320
1285
  #
1321
1286
  # @option params [required, String] :action
1322
- # The action that you're enabling the other account to perform.
1287
+ # The action that you are enabling the other account to perform.
1323
1288
  # Currently, this must be `events:PutEvents`.
1324
1289
  #
1325
1290
  # @option params [required, String] :principal
@@ -1328,14 +1293,14 @@ module Aws::CloudWatchEvents
1328
1293
  # events to your default event bus.
1329
1294
  #
1330
1295
  # If you specify "*" without specifying `Condition`, avoid creating
1331
- # rules that might match undesirable events. To create more secure
1332
- # rules, make sure that the event pattern for each rule contains an
1333
- # `account` field with a specific account ID to receive events from.
1334
- # Rules with an account field don't match any events sent from other
1296
+ # rules that may match undesirable events. To create more secure rules,
1297
+ # make sure that the event pattern for each rule contains an `account`
1298
+ # field with a specific account ID from which to receive events. Rules
1299
+ # with an account field do not match any events sent from other
1335
1300
  # accounts.
1336
1301
  #
1337
1302
  # @option params [required, String] :statement_id
1338
- # An identifier string for the external account that you're granting
1303
+ # An identifier string for the external account that you are granting
1339
1304
  # permissions to. If you later want to revoke the permission for this
1340
1305
  # external account, specify this `StatementId` when you run
1341
1306
  # RemovePermission.
@@ -1344,13 +1309,13 @@ module Aws::CloudWatchEvents
1344
1309
  # This parameter enables you to limit the permission to accounts that
1345
1310
  # fulfill a certain condition, such as being a member of a certain AWS
1346
1311
  # organization. For more information about AWS Organizations, see [What
1347
- # Is AWS Organizations?][1] in the *AWS Organizations User Guide*.
1312
+ # Is AWS Organizations][1] in the *AWS Organizations User Guide*.
1348
1313
  #
1349
- # If you specify `Condition` with an AWS organization ID and specify
1314
+ # If you specify `Condition` with an AWS organization ID, and specify
1350
1315
  # "*" as the value for `Principal`, you grant permission to all the
1351
1316
  # accounts in the named organization.
1352
1317
  #
1353
- # The `Condition` is a JSON string that must contain `Type`, `Key`, and
1318
+ # The `Condition` is a JSON string which must contain `Type`, `Key`, and
1354
1319
  # `Value` fields.
1355
1320
  #
1356
1321
  #
@@ -1382,8 +1347,9 @@ module Aws::CloudWatchEvents
1382
1347
  req.send_request(options)
1383
1348
  end
1384
1349
 
1385
- # Creates or updates the specified rule. Rules are enabled by default or
1386
- # based on value of the state. You can disable a rule using DisableRule.
1350
+ # Creates or updates the specified rule. Rules are enabled by default,
1351
+ # or based on value of the state. You can disable a rule using
1352
+ # DisableRule.
1387
1353
  #
1388
1354
  # A single rule watches for events from a single event bus. Events
1389
1355
  # generated by AWS services go to your account's default event bus.
@@ -1393,21 +1359,21 @@ module Aws::CloudWatchEvents
1393
1359
  # event bus or a custom event bus that you have created. For more
1394
1360
  # information, see CreateEventBus.
1395
1361
  #
1396
- # If you're updating an existing rule, the rule is replaced with what
1362
+ # If you are updating an existing rule, the rule is replaced with what
1397
1363
  # you specify in this `PutRule` command. If you omit arguments in
1398
- # `PutRule`, the old values for those arguments aren't kept. Instead,
1399
- # they're replaced with null values.
1364
+ # `PutRule`, the old values for those arguments are not kept. Instead,
1365
+ # they are replaced with null values.
1400
1366
  #
1401
1367
  # When you create or update a rule, incoming events might not
1402
1368
  # immediately start matching to new or updated rules. Allow a short
1403
1369
  # period of time for changes to take effect.
1404
1370
  #
1405
- # A rule must contain at least an `EventPattern` or
1406
- # `ScheduleExpression`. Rules with `EventPatterns` are triggered when a
1407
- # matching event is observed. Rules with `ScheduleExpressions`
1408
- # self-trigger based on the given schedule. A rule can have both an
1409
- # `EventPattern` and a `ScheduleExpression`, in which case the rule
1410
- # triggers on matching events as well as on a schedule.
1371
+ # A rule must contain at least an EventPattern or ScheduleExpression.
1372
+ # Rules with EventPatterns are triggered when a matching event is
1373
+ # observed. Rules with ScheduleExpressions self-trigger based on the
1374
+ # given schedule. A rule can have both an EventPattern and a
1375
+ # ScheduleExpression, in which case the rule triggers on matching events
1376
+ # as well as on a schedule.
1411
1377
  #
1412
1378
  # When you initially create a rule, you can optionally assign one or
1413
1379
  # more tags to the rule. Tags can help you organize and categorize your
@@ -1420,21 +1386,21 @@ module Aws::CloudWatchEvents
1420
1386
  # `PutRule` operation are ignored. To update the tags of an existing
1421
1387
  # rule, use TagResource and UntagResource.
1422
1388
  #
1423
- # Most services in AWS treat `:` or `/` as the same character in Amazon
1389
+ # Most services in AWS treat : or / as the same character in Amazon
1424
1390
  # Resource Names (ARNs). However, EventBridge uses an exact match in
1425
1391
  # event patterns and rules. Be sure to use the correct ARN characters
1426
1392
  # when creating event patterns so that they match the ARN syntax in the
1427
- # event that you want to match.
1393
+ # event you want to match.
1428
1394
  #
1429
- # In EventBridge, you could create rules that lead to infinite loops,
1430
- # where a rule is fired repeatedly. For example, a rule might detect
1431
- # that ACLs have changed on an S3 bucket, and trigger software to change
1432
- # them to the desired state. If you don't write the rule carefully, the
1433
- # subsequent change to the ACLs fires the rule again, creating an
1434
- # infinite loop.
1395
+ # In EventBridge, it is possible to create rules that lead to infinite
1396
+ # loops, where a rule is fired repeatedly. For example, a rule might
1397
+ # detect that ACLs have changed on an S3 bucket, and trigger software to
1398
+ # change them to the desired state. If the rule is not written
1399
+ # carefully, the subsequent change to the ACLs fires the rule again,
1400
+ # creating an infinite loop.
1435
1401
  #
1436
- # To prevent this, write the rules so that the triggered actions don't
1437
- # refire the same rule. For example, your rule could fire only if ACLs
1402
+ # To prevent this, write the rules so that the triggered actions do not
1403
+ # re-fire the same rule. For example, your rule could fire only if ACLs
1438
1404
  # are found to be in a bad state, instead of after any change.
1439
1405
  #
1440
1406
  # An infinite loop can quickly cause higher than expected charges. We
@@ -1447,15 +1413,15 @@ module Aws::CloudWatchEvents
1447
1413
  # [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html
1448
1414
  #
1449
1415
  # @option params [required, String] :name
1450
- # The name of the rule that you're creating or updating.
1416
+ # The name of the rule that you are creating or updating.
1451
1417
  #
1452
1418
  # @option params [String] :schedule_expression
1453
- # The scheduling expression: for example, `"cron(0 20 * * ? *)"` or
1454
- # `"rate(5 minutes)"`.
1419
+ # The scheduling expression. For example, "cron(0 20 * * ? *)" or
1420
+ # "rate(5 minutes)".
1455
1421
  #
1456
1422
  # @option params [String] :event_pattern
1457
- # The event pattern. For more information, see [Event Patterns][1] in
1458
- # the *Amazon EventBridge User Guide*.
1423
+ # The event pattern. For more information, see [Events and Event
1424
+ # Patterns][1] in the *Amazon EventBridge User Guide*.
1459
1425
  #
1460
1426
  #
1461
1427
  #
@@ -1514,11 +1480,11 @@ module Aws::CloudWatchEvents
1514
1480
  end
1515
1481
 
1516
1482
  # Adds the specified targets to the specified rule, or updates the
1517
- # targets if they're already associated with the rule.
1483
+ # targets if they are already associated with the rule.
1518
1484
  #
1519
1485
  # Targets are the resources that are invoked when a rule is triggered.
1520
1486
  #
1521
- # You can configure the following as targets in EventBridge:
1487
+ # You can configure the following as targets for Events:
1522
1488
  #
1523
1489
  # * EC2 instances
1524
1490
  #
@@ -1550,7 +1516,7 @@ module Aws::CloudWatchEvents
1550
1516
  #
1551
1517
  # * The default event bus of another AWS account
1552
1518
  #
1553
- # Creating rules with built-in targets is supported only on the AWS
1519
+ # Creating rules with built-in targets is supported only in the AWS
1554
1520
  # Management Console. The built-in targets are `EC2 CreateSnapshot API
1555
1521
  # call`, `EC2 RebootInstances API call`, `EC2 StopInstances API call`,
1556
1522
  # and `EC2 TerminateInstances API call`.
@@ -1562,15 +1528,15 @@ module Aws::CloudWatchEvents
1562
1528
  # you can use the `RunCommandParameters` field.
1563
1529
  #
1564
1530
  # To be able to make API calls against the resources that you own,
1565
- # Amazon EventBridge needs the appropriate permissions. For AWS Lambda
1566
- # and Amazon SNS resources, EventBridge relies on resource-based
1531
+ # Amazon CloudWatch Events needs the appropriate permissions. For AWS
1532
+ # Lambda and Amazon SNS resources, EventBridge relies on resource-based
1567
1533
  # policies. For EC2 instances, Kinesis data streams, and AWS Step
1568
1534
  # Functions state machines, EventBridge relies on IAM roles that you
1569
1535
  # specify in the `RoleARN` argument in `PutTargets`. For more
1570
1536
  # information, see [Authentication and Access Control][1] in the *Amazon
1571
1537
  # EventBridge User Guide*.
1572
1538
  #
1573
- # If another AWS account is in the same Region and has granted you
1539
+ # If another AWS account is in the same region and has granted you
1574
1540
  # permission (using `PutPermission`), you can send events to that
1575
1541
  # account. Set that account's event bus as a target of the rules in
1576
1542
  # your account. To send the matched events to the other account, specify
@@ -1578,39 +1544,44 @@ module Aws::CloudWatchEvents
1578
1544
  # `PutTargets`. If your account sends events to another account, your
1579
1545
  # account is charged for each sent event. Each event sent to another
1580
1546
  # account is charged as a custom event. The account receiving the event
1581
- # isn't charged. For more information, see [Amazon EventBridge
1547
+ # is not charged. For more information, see [Amazon CloudWatch
1582
1548
  # Pricing][2].
1583
1549
  #
1584
- # If you're setting an event bus in another account as the target and
1550
+ # <note markdown="1"> `Input`, `InputPath`, and `InputTransformer` are not available with
1551
+ # `PutTarget` if the target is an event bus of a different AWS account.
1552
+ #
1553
+ # </note>
1554
+ #
1555
+ # If you are setting the event bus of another account as the target, and
1585
1556
  # that account granted permission to your account through an
1586
- # organization instead of directly by the account ID, you must specify a
1587
- # `RoleArn` with proper permissions in the `Target` structure. For more
1588
- # information, see [Sending and Receiving Events Between AWS
1557
+ # organization instead of directly by the account ID, then you must
1558
+ # specify a `RoleArn` with proper permissions in the `Target` structure.
1559
+ # For more information, see [Sending and Receiving Events Between AWS
1589
1560
  # Accounts][3] in the *Amazon EventBridge User Guide*.
1590
1561
  #
1591
1562
  # For more information about enabling cross-account events, see
1592
1563
  # PutPermission.
1593
1564
  #
1594
- # `Input`, `InputPath`, and `InputTransformer` are mutually exclusive
1595
- # and optional parameters of a target. When a rule is triggered due to a
1596
- # matched event:
1565
+ # **Input**, **InputPath**, and **InputTransformer** are mutually
1566
+ # exclusive and optional parameters of a target. When a rule is
1567
+ # triggered due to a matched event:
1597
1568
  #
1598
- # * If none of the following arguments are specified for a target, the
1599
- # entire event is passed to the target in JSON format (unless the
1569
+ # * If none of the following arguments are specified for a target, then
1570
+ # the entire event is passed to the target in JSON format (unless the
1600
1571
  # target is Amazon EC2 Run Command or Amazon ECS task, in which case
1601
1572
  # nothing from the event is passed to the target).
1602
1573
  #
1603
- # * If `Input` is specified in the form of valid JSON, then the matched
1604
- # event is overridden with this constant.
1574
+ # * If **Input** is specified in the form of valid JSON, then the
1575
+ # matched event is overridden with this constant.
1605
1576
  #
1606
- # * If `InputPath` is specified in the form of JSONPath (for example,
1607
- # `$.detail`), only the part of the event specified in the path is
1608
- # passed to the target (for example, only the detail part of the event
1609
- # is passed).
1577
+ # * If **InputPath** is specified in the form of JSONPath (for example,
1578
+ # `$.detail`), then only the part of the event specified in the path
1579
+ # is passed to the target (for example, only the detail part of the
1580
+ # event is passed).
1610
1581
  #
1611
- # * If `InputTransformer` is specified, one or more specified JSONPaths
1612
- # are extracted from the event and used as values in a template that
1613
- # you specify as the input to the target.
1582
+ # * If **InputTransformer** is specified, then one or more specified
1583
+ # JSONPaths are extracted from the event and used as values in a
1584
+ # template that you specify as the input to the target.
1614
1585
  #
1615
1586
  # When you specify `InputPath` or `InputTransformer`, you must use JSON
1616
1587
  # dot notation, not bracket notation.
@@ -1620,14 +1591,14 @@ module Aws::CloudWatchEvents
1620
1591
  # a short period of time for changes to take effect.
1621
1592
  #
1622
1593
  # This action can partially fail if too many requests are made at the
1623
- # same time. If that happens, `FailedEntryCount` is nonzero in the
1624
- # response, and each entry in `FailedEntries` provides the ID of the
1594
+ # same time. If that happens, `FailedEntryCount` is non-zero in the
1595
+ # response and each entry in `FailedEntries` provides the ID of the
1625
1596
  # failed target and the error code.
1626
1597
  #
1627
1598
  #
1628
1599
  #
1629
1600
  # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html
1630
- # [2]: https://aws.amazon.com/eventbridge/pricing/
1601
+ # [2]: https://aws.amazon.com/cloudwatch/pricing/
1631
1602
  # [3]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
1632
1603
  #
1633
1604
  # @option params [required, String] :rule
@@ -1776,9 +1747,9 @@ module Aws::CloudWatchEvents
1776
1747
  # The IDs of the targets to remove from the rule.
1777
1748
  #
1778
1749
  # @option params [Boolean] :force
1779
- # If this is a managed rule created by an AWS service on your behalf,
1750
+ # If this is a managed rule, created by an AWS service on your behalf,
1780
1751
  # you must specify `Force` as `True` to remove targets. This parameter
1781
- # is ignored for rules that aren't managed rules. You can check whether
1752
+ # is ignored for rules that are not managed rules. You can check whether
1782
1753
  # a rule is a managed rule by using `DescribeRule` or `ListRules` and
1783
1754
  # checking the `ManagedBy` field of the response.
1784
1755
  #
@@ -1817,24 +1788,24 @@ module Aws::CloudWatchEvents
1817
1788
  # EventBridge resource. Tags can help you organize and categorize your
1818
1789
  # resources. You can also use them to scope user permissions by granting
1819
1790
  # a user permission to access or change only resources with certain tag
1820
- # values. In EventBridge, rules can be tagged.
1791
+ # values. In EventBridge, rules and event buses can be tagged.
1821
1792
  #
1822
1793
  # Tags don't have any semantic meaning to AWS and are interpreted
1823
1794
  # strictly as strings of characters.
1824
1795
  #
1825
- # You can use the `TagResource` action with a rule that already has
1826
- # tags. If you specify a new tag key for the rule, this tag is appended
1827
- # to the list of tags associated with the rule. If you specify a tag key
1828
- # that is already associated with the rule, the new tag value that you
1796
+ # You can use the `TagResource` action with a resource that already has
1797
+ # tags. If you specify a new tag key, this tag is appended to the list
1798
+ # of tags associated with the resource. If you specify a tag key that is
1799
+ # already associated with the resource, the new tag value that you
1829
1800
  # specify replaces the previous value for that tag.
1830
1801
  #
1831
1802
  # You can associate as many as 50 tags with a resource.
1832
1803
  #
1833
1804
  # @option params [required, String] :resource_arn
1834
- # The ARN of the rule that you're adding tags to.
1805
+ # The ARN of the EventBridge resource that you're adding tags to.
1835
1806
  #
1836
1807
  # @option params [required, Array<Types::Tag>] :tags
1837
- # The list of key-value pairs to associate with the rule.
1808
+ # The list of key-value pairs to associate with the resource.
1838
1809
  #
1839
1810
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1840
1811
  #
@@ -1861,15 +1832,15 @@ module Aws::CloudWatchEvents
1861
1832
 
1862
1833
  # Tests whether the specified event pattern matches the provided event.
1863
1834
  #
1864
- # Most services in AWS treat `:` or `/` as the same character in Amazon
1835
+ # Most services in AWS treat : or / as the same character in Amazon
1865
1836
  # Resource Names (ARNs). However, EventBridge uses an exact match in
1866
1837
  # event patterns and rules. Be sure to use the correct ARN characters
1867
1838
  # when creating event patterns so that they match the ARN syntax in the
1868
- # event that you want to match.
1839
+ # event you want to match.
1869
1840
  #
1870
1841
  # @option params [required, String] :event_pattern
1871
- # The event pattern. For more information, see [Event Patterns][1] in
1872
- # the *Amazon EventBridge User Guide*.
1842
+ # The event pattern. For more information, see [Events and Event
1843
+ # Patterns][1] in the *Amazon EventBridge User Guide*.
1873
1844
  #
1874
1845
  #
1875
1846
  #
@@ -1903,10 +1874,10 @@ module Aws::CloudWatchEvents
1903
1874
  end
1904
1875
 
1905
1876
  # Removes one or more tags from the specified EventBridge resource. In
1906
- # EventBridge, rules can be tagged.
1877
+ # CloudWatch Events, rules and event buses can be tagged.
1907
1878
  #
1908
1879
  # @option params [required, String] :resource_arn
1909
- # The ARN of the rule that you're removing tags from.
1880
+ # The ARN of the EventBridge resource from which you are removing tags.
1910
1881
  #
1911
1882
  # @option params [required, Array<String>] :tag_keys
1912
1883
  # The list of tag keys to remove from the resource.
@@ -1942,7 +1913,7 @@ module Aws::CloudWatchEvents
1942
1913
  params: params,
1943
1914
  config: config)
1944
1915
  context[:gem_name] = 'aws-sdk-cloudwatchevents'
1945
- context[:gem_version] = '1.25.0'
1916
+ context[:gem_version] = '1.26.0'
1946
1917
  Seahorse::Client::Request.new(handlers, context)
1947
1918
  end
1948
1919