aws-sdk-cloudwatchevents 1.22.0 → 1.23.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-cloudwatchevents.rb +1 -1
- data/lib/aws-sdk-cloudwatchevents/client.rb +777 -128
- data/lib/aws-sdk-cloudwatchevents/client_api.rb +331 -0
- data/lib/aws-sdk-cloudwatchevents/types.rb +926 -105
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 49970f2b53a308f105e6a0d1007066b9740710b6
|
4
|
+
data.tar.gz: 41bce79e822196782826cf57eb52e17e67126c1c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1eac81322b2328eb6792e90579afc1d51f2cfa8110b6d47e0c472eb30e351893ba1bceeb66bc28731bc56abca5cfafd7a13330c3d88f99b467a302a1eb32a07c
|
7
|
+
data.tar.gz: 71c7b3efa68d71399a52cc8430bd3e458d5600185dfdcef986d3ebe014e89e5887a2efc04c07a857f19855f4771dbbca517d5b4ccc90a74ca7d9995315492aa5
|
@@ -264,6 +264,241 @@ module Aws::CloudWatchEvents
|
|
264
264
|
|
265
265
|
# @!group API Operations
|
266
266
|
|
267
|
+
# Activates a partner event source that has been deactivated. Once
|
268
|
+
# activated, your matching event bus will start receiving events from
|
269
|
+
# the event source.
|
270
|
+
#
|
271
|
+
# <note markdown="1"> This operation is performed by AWS customers, not by SaaS partners.
|
272
|
+
#
|
273
|
+
# </note>
|
274
|
+
#
|
275
|
+
# @option params [required, String] :name
|
276
|
+
# The name of the partner event source to activate.
|
277
|
+
#
|
278
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
279
|
+
#
|
280
|
+
# @example Request syntax with placeholder values
|
281
|
+
#
|
282
|
+
# resp = client.activate_event_source({
|
283
|
+
# name: "EventSourceName", # required
|
284
|
+
# })
|
285
|
+
#
|
286
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ActivateEventSource AWS API Documentation
|
287
|
+
#
|
288
|
+
# @overload activate_event_source(params = {})
|
289
|
+
# @param [Hash] params ({})
|
290
|
+
def activate_event_source(params = {}, options = {})
|
291
|
+
req = build_request(:activate_event_source, params)
|
292
|
+
req.send_request(options)
|
293
|
+
end
|
294
|
+
|
295
|
+
# 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
|
297
|
+
# applications and services, or it can be a partner event bus which can
|
298
|
+
# be matched to a partner event source.
|
299
|
+
#
|
300
|
+
# <note markdown="1"> This operation is used by AWS customers, not by SaaS partners.
|
301
|
+
#
|
302
|
+
# </note>
|
303
|
+
#
|
304
|
+
# @option params [required, String] :name
|
305
|
+
# The name of the new event bus.
|
306
|
+
#
|
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.
|
310
|
+
#
|
311
|
+
# 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.
|
314
|
+
#
|
315
|
+
# @option params [String] :event_source_name
|
316
|
+
# If you're creating a partner event bus, this specifies the partner
|
317
|
+
# event source that the new event bus will be matched with.
|
318
|
+
#
|
319
|
+
# @return [Types::CreateEventBusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
320
|
+
#
|
321
|
+
# * {Types::CreateEventBusResponse#event_bus_arn #event_bus_arn} => String
|
322
|
+
#
|
323
|
+
# @example Request syntax with placeholder values
|
324
|
+
#
|
325
|
+
# resp = client.create_event_bus({
|
326
|
+
# name: "EventBusName", # required
|
327
|
+
# event_source_name: "EventSourceName",
|
328
|
+
# })
|
329
|
+
#
|
330
|
+
# @example Response structure
|
331
|
+
#
|
332
|
+
# resp.event_bus_arn #=> String
|
333
|
+
#
|
334
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateEventBus AWS API Documentation
|
335
|
+
#
|
336
|
+
# @overload create_event_bus(params = {})
|
337
|
+
# @param [Hash] params ({})
|
338
|
+
def create_event_bus(params = {}, options = {})
|
339
|
+
req = build_request(:create_event_bus, params)
|
340
|
+
req.send_request(options)
|
341
|
+
end
|
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>
|
348
|
+
#
|
349
|
+
# Each partner event source can be used by one AWS account to create a
|
350
|
+
# matching partner event bus in that AWS account. A SaaS partner must
|
351
|
+
# create one partner event source for each AWS account that wants to
|
352
|
+
# receive those event types.
|
353
|
+
#
|
354
|
+
# A partner event source creates events based on resources in the SaaS
|
355
|
+
# partner's service or application.
|
356
|
+
#
|
357
|
+
# An AWS account that creates a partner event bus that matches the
|
358
|
+
# partner event source can use that event bus to receive events from the
|
359
|
+
# partner, and then process them using AWS Events rules and targets.
|
360
|
+
#
|
361
|
+
# Partner event source names follow this format:
|
362
|
+
#
|
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.
|
367
|
+
#
|
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.
|
376
|
+
#
|
377
|
+
# @option params [required, String] :name
|
378
|
+
# The name of the partner event source. This name must be unique and
|
379
|
+
# must be in the format ` partner_name/event_namespace/event_name `. The
|
380
|
+
# AWS account that wants to use this partner event source must create a
|
381
|
+
# partner event bus with a name that matches the name of the partner
|
382
|
+
# event source.
|
383
|
+
#
|
384
|
+
# @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.
|
387
|
+
#
|
388
|
+
# @return [Types::CreatePartnerEventSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
389
|
+
#
|
390
|
+
# * {Types::CreatePartnerEventSourceResponse#event_source_arn #event_source_arn} => String
|
391
|
+
#
|
392
|
+
# @example Request syntax with placeholder values
|
393
|
+
#
|
394
|
+
# resp = client.create_partner_event_source({
|
395
|
+
# name: "EventSourceName", # required
|
396
|
+
# account: "AccountId", # required
|
397
|
+
# })
|
398
|
+
#
|
399
|
+
# @example Response structure
|
400
|
+
#
|
401
|
+
# resp.event_source_arn #=> String
|
402
|
+
#
|
403
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreatePartnerEventSource AWS API Documentation
|
404
|
+
#
|
405
|
+
# @overload create_partner_event_source(params = {})
|
406
|
+
# @param [Hash] params ({})
|
407
|
+
def create_partner_event_source(params = {}, options = {})
|
408
|
+
req = build_request(:create_partner_event_source, params)
|
409
|
+
req.send_request(options)
|
410
|
+
end
|
411
|
+
|
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.
|
415
|
+
#
|
416
|
+
# 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.
|
419
|
+
#
|
420
|
+
# To activate a deactivated partner event source, use
|
421
|
+
# ActivateEventSource.
|
422
|
+
#
|
423
|
+
# @option params [required, String] :name
|
424
|
+
# The name of the partner event source to deactivate.
|
425
|
+
#
|
426
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
427
|
+
#
|
428
|
+
# @example Request syntax with placeholder values
|
429
|
+
#
|
430
|
+
# resp = client.deactivate_event_source({
|
431
|
+
# name: "EventSourceName", # required
|
432
|
+
# })
|
433
|
+
#
|
434
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeactivateEventSource AWS API Documentation
|
435
|
+
#
|
436
|
+
# @overload deactivate_event_source(params = {})
|
437
|
+
# @param [Hash] params ({})
|
438
|
+
def deactivate_event_source(params = {}, options = {})
|
439
|
+
req = build_request(:deactivate_event_source, params)
|
440
|
+
req.send_request(options)
|
441
|
+
end
|
442
|
+
|
443
|
+
# 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
|
445
|
+
# your account's default event bus.
|
446
|
+
#
|
447
|
+
# <note markdown="1"> This operation is performed by AWS customers, not by SaaS partners.
|
448
|
+
#
|
449
|
+
# </note>
|
450
|
+
#
|
451
|
+
# @option params [required, String] :name
|
452
|
+
# The name of the event bus to delete.
|
453
|
+
#
|
454
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
455
|
+
#
|
456
|
+
# @example Request syntax with placeholder values
|
457
|
+
#
|
458
|
+
# resp = client.delete_event_bus({
|
459
|
+
# name: "EventBusName", # required
|
460
|
+
# })
|
461
|
+
#
|
462
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteEventBus AWS API Documentation
|
463
|
+
#
|
464
|
+
# @overload delete_event_bus(params = {})
|
465
|
+
# @param [Hash] params ({})
|
466
|
+
def delete_event_bus(params = {}, options = {})
|
467
|
+
req = build_request(:delete_event_bus, params)
|
468
|
+
req.send_request(options)
|
469
|
+
end
|
470
|
+
|
471
|
+
# This operation is used by SaaS partners to delete a partner event
|
472
|
+
# source. AWS customers don't use this operation.
|
473
|
+
#
|
474
|
+
# When you delete an event source, the status of the corresponding
|
475
|
+
# partner event bus in the AWS customer account becomes `DELETED`.
|
476
|
+
#
|
477
|
+
# @option params [required, String] :name
|
478
|
+
# The name of the event source to delete.
|
479
|
+
#
|
480
|
+
# @option params [required, String] :account
|
481
|
+
# The AWS account ID of the AWS customer that the event source was
|
482
|
+
# created for.
|
483
|
+
#
|
484
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
485
|
+
#
|
486
|
+
# @example Request syntax with placeholder values
|
487
|
+
#
|
488
|
+
# resp = client.delete_partner_event_source({
|
489
|
+
# name: "EventSourceName", # required
|
490
|
+
# account: "AccountId", # required
|
491
|
+
# })
|
492
|
+
#
|
493
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeletePartnerEventSource AWS API Documentation
|
494
|
+
#
|
495
|
+
# @overload delete_partner_event_source(params = {})
|
496
|
+
# @param [Hash] params ({})
|
497
|
+
def delete_partner_event_source(params = {}, options = {})
|
498
|
+
req = build_request(:delete_partner_event_source, params)
|
499
|
+
req.send_request(options)
|
500
|
+
end
|
501
|
+
|
267
502
|
# Deletes the specified rule.
|
268
503
|
#
|
269
504
|
# Before you can delete the rule, you must remove all targets, using
|
@@ -275,12 +510,16 @@ module Aws::CloudWatchEvents
|
|
275
510
|
# Managed rules are rules created and managed by another AWS service on
|
276
511
|
# your behalf. These rules are created by those other AWS services to
|
277
512
|
# support functionality in those services. You can delete these rules
|
278
|
-
# using the `Force` option, but you should do so only if you
|
279
|
-
# the other service
|
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.
|
280
515
|
#
|
281
516
|
# @option params [required, String] :name
|
282
517
|
# The name of the rule.
|
283
518
|
#
|
519
|
+
# @option params [String] :event_bus_name
|
520
|
+
# The event bus associated with the rule. If you omit this, the default
|
521
|
+
# event bus is used.
|
522
|
+
#
|
284
523
|
# @option params [Boolean] :force
|
285
524
|
# If this is a managed rule, created by an AWS service on your behalf,
|
286
525
|
# you must specify `Force` as `True` to delete the rule. This parameter
|
@@ -294,6 +533,7 @@ module Aws::CloudWatchEvents
|
|
294
533
|
#
|
295
534
|
# resp = client.delete_rule({
|
296
535
|
# name: "RuleName", # required
|
536
|
+
# event_bus_name: "EventBusName",
|
297
537
|
# force: false,
|
298
538
|
# })
|
299
539
|
#
|
@@ -306,10 +546,20 @@ module Aws::CloudWatchEvents
|
|
306
546
|
req.send_request(options)
|
307
547
|
end
|
308
548
|
|
309
|
-
# Displays
|
310
|
-
#
|
311
|
-
#
|
312
|
-
#
|
549
|
+
# Displays details about an event bus in your account. This can include
|
550
|
+
# the external AWS accounts that are permitted to write events to your
|
551
|
+
# default event bus, and the associated policy. For custom event buses
|
552
|
+
# and partner event buses, it displays the name, ARN, policy, state, and
|
553
|
+
# creation time.
|
554
|
+
#
|
555
|
+
# To enable your account to receive events from other accounts on its
|
556
|
+
# default event bus, use PutPermission.
|
557
|
+
#
|
558
|
+
# For more information about partner event buses, see CreateEventBus.
|
559
|
+
#
|
560
|
+
# @option params [String] :name
|
561
|
+
# The name of the event bus to show details for. If you omit this, the
|
562
|
+
# default event bus is displayed.
|
313
563
|
#
|
314
564
|
# @return [Types::DescribeEventBusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
315
565
|
#
|
@@ -317,6 +567,12 @@ module Aws::CloudWatchEvents
|
|
317
567
|
# * {Types::DescribeEventBusResponse#arn #arn} => String
|
318
568
|
# * {Types::DescribeEventBusResponse#policy #policy} => String
|
319
569
|
#
|
570
|
+
# @example Request syntax with placeholder values
|
571
|
+
#
|
572
|
+
# resp = client.describe_event_bus({
|
573
|
+
# name: "EventBusName",
|
574
|
+
# })
|
575
|
+
#
|
320
576
|
# @example Response structure
|
321
577
|
#
|
322
578
|
# resp.name #=> String
|
@@ -332,14 +588,98 @@ module Aws::CloudWatchEvents
|
|
332
588
|
req.send_request(options)
|
333
589
|
end
|
334
590
|
|
591
|
+
# This operation lists details about a partner event source that is
|
592
|
+
# shared with your account.
|
593
|
+
#
|
594
|
+
# <note markdown="1"> This operation is run by AWS customers, not by SaaS partners.
|
595
|
+
#
|
596
|
+
# </note>
|
597
|
+
#
|
598
|
+
# @option params [required, String] :name
|
599
|
+
# The name of the partner event source to display the details of.
|
600
|
+
#
|
601
|
+
# @return [Types::DescribeEventSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
602
|
+
#
|
603
|
+
# * {Types::DescribeEventSourceResponse#arn #arn} => String
|
604
|
+
# * {Types::DescribeEventSourceResponse#created_by #created_by} => String
|
605
|
+
# * {Types::DescribeEventSourceResponse#creation_time #creation_time} => Time
|
606
|
+
# * {Types::DescribeEventSourceResponse#expiration_time #expiration_time} => Time
|
607
|
+
# * {Types::DescribeEventSourceResponse#name #name} => String
|
608
|
+
# * {Types::DescribeEventSourceResponse#state #state} => String
|
609
|
+
#
|
610
|
+
# @example Request syntax with placeholder values
|
611
|
+
#
|
612
|
+
# resp = client.describe_event_source({
|
613
|
+
# name: "EventSourceName", # required
|
614
|
+
# })
|
615
|
+
#
|
616
|
+
# @example Response structure
|
617
|
+
#
|
618
|
+
# resp.arn #=> String
|
619
|
+
# resp.created_by #=> String
|
620
|
+
# resp.creation_time #=> Time
|
621
|
+
# resp.expiration_time #=> Time
|
622
|
+
# resp.name #=> String
|
623
|
+
# resp.state #=> String, one of "PENDING", "ACTIVE", "DELETED"
|
624
|
+
#
|
625
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeEventSource AWS API Documentation
|
626
|
+
#
|
627
|
+
# @overload describe_event_source(params = {})
|
628
|
+
# @param [Hash] params ({})
|
629
|
+
def describe_event_source(params = {}, options = {})
|
630
|
+
req = build_request(:describe_event_source, params)
|
631
|
+
req.send_request(options)
|
632
|
+
end
|
633
|
+
|
634
|
+
# 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>
|
642
|
+
#
|
643
|
+
# @option params [required, String] :name
|
644
|
+
# The name of the event source to display.
|
645
|
+
#
|
646
|
+
# @return [Types::DescribePartnerEventSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
647
|
+
#
|
648
|
+
# * {Types::DescribePartnerEventSourceResponse#arn #arn} => String
|
649
|
+
# * {Types::DescribePartnerEventSourceResponse#name #name} => String
|
650
|
+
#
|
651
|
+
# @example Request syntax with placeholder values
|
652
|
+
#
|
653
|
+
# resp = client.describe_partner_event_source({
|
654
|
+
# name: "EventSourceName", # required
|
655
|
+
# })
|
656
|
+
#
|
657
|
+
# @example Response structure
|
658
|
+
#
|
659
|
+
# resp.arn #=> String
|
660
|
+
# resp.name #=> String
|
661
|
+
#
|
662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribePartnerEventSource AWS API Documentation
|
663
|
+
#
|
664
|
+
# @overload describe_partner_event_source(params = {})
|
665
|
+
# @param [Hash] params ({})
|
666
|
+
def describe_partner_event_source(params = {}, options = {})
|
667
|
+
req = build_request(:describe_partner_event_source, params)
|
668
|
+
req.send_request(options)
|
669
|
+
end
|
670
|
+
|
335
671
|
# Describes the specified rule.
|
336
672
|
#
|
337
|
-
# DescribeRule
|
673
|
+
# `DescribeRule` doesn't list the targets of a rule. To see the targets
|
338
674
|
# associated with a rule, use ListTargetsByRule.
|
339
675
|
#
|
340
676
|
# @option params [required, String] :name
|
341
677
|
# The name of the rule.
|
342
678
|
#
|
679
|
+
# @option params [String] :event_bus_name
|
680
|
+
# The event bus associated with the rule. If you omit this, the default
|
681
|
+
# event bus is used.
|
682
|
+
#
|
343
683
|
# @return [Types::DescribeRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
344
684
|
#
|
345
685
|
# * {Types::DescribeRuleResponse#name #name} => String
|
@@ -350,11 +690,13 @@ module Aws::CloudWatchEvents
|
|
350
690
|
# * {Types::DescribeRuleResponse#description #description} => String
|
351
691
|
# * {Types::DescribeRuleResponse#role_arn #role_arn} => String
|
352
692
|
# * {Types::DescribeRuleResponse#managed_by #managed_by} => String
|
693
|
+
# * {Types::DescribeRuleResponse#event_bus_name #event_bus_name} => String
|
353
694
|
#
|
354
695
|
# @example Request syntax with placeholder values
|
355
696
|
#
|
356
697
|
# resp = client.describe_rule({
|
357
698
|
# name: "RuleName", # required
|
699
|
+
# event_bus_name: "EventBusName",
|
358
700
|
# })
|
359
701
|
#
|
360
702
|
# @example Response structure
|
@@ -367,6 +709,7 @@ module Aws::CloudWatchEvents
|
|
367
709
|
# resp.description #=> String
|
368
710
|
# resp.role_arn #=> String
|
369
711
|
# resp.managed_by #=> String
|
712
|
+
# resp.event_bus_name #=> String
|
370
713
|
#
|
371
714
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeRule AWS API Documentation
|
372
715
|
#
|
@@ -377,7 +720,7 @@ module Aws::CloudWatchEvents
|
|
377
720
|
req.send_request(options)
|
378
721
|
end
|
379
722
|
|
380
|
-
# Disables the specified rule. A disabled rule won't match any events
|
723
|
+
# Disables the specified rule. A disabled rule won't match any events
|
381
724
|
# and won't self-trigger if it has a schedule expression.
|
382
725
|
#
|
383
726
|
# When you disable a rule, incoming events might continue to match to
|
@@ -387,12 +730,17 @@ module Aws::CloudWatchEvents
|
|
387
730
|
# @option params [required, String] :name
|
388
731
|
# The name of the rule.
|
389
732
|
#
|
733
|
+
# @option params [String] :event_bus_name
|
734
|
+
# The event bus associated with the rule. If you omit this, the default
|
735
|
+
# event bus is used.
|
736
|
+
#
|
390
737
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
391
738
|
#
|
392
739
|
# @example Request syntax with placeholder values
|
393
740
|
#
|
394
741
|
# resp = client.disable_rule({
|
395
742
|
# name: "RuleName", # required
|
743
|
+
# event_bus_name: "EventBusName",
|
396
744
|
# })
|
397
745
|
#
|
398
746
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DisableRule AWS API Documentation
|
@@ -404,7 +752,7 @@ module Aws::CloudWatchEvents
|
|
404
752
|
req.send_request(options)
|
405
753
|
end
|
406
754
|
|
407
|
-
# Enables the specified rule. If the rule
|
755
|
+
# Enables the specified rule. If the rule doesn't exist, the operation
|
408
756
|
# fails.
|
409
757
|
#
|
410
758
|
# When you enable a rule, incoming events might not immediately start
|
@@ -414,12 +762,17 @@ module Aws::CloudWatchEvents
|
|
414
762
|
# @option params [required, String] :name
|
415
763
|
# The name of the rule.
|
416
764
|
#
|
765
|
+
# @option params [String] :event_bus_name
|
766
|
+
# The event bus associated with the rule. If you omit this, the default
|
767
|
+
# event bus is used.
|
768
|
+
#
|
417
769
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
418
770
|
#
|
419
771
|
# @example Request syntax with placeholder values
|
420
772
|
#
|
421
773
|
# resp = client.enable_rule({
|
422
774
|
# name: "RuleName", # required
|
775
|
+
# event_bus_name: "EventBusName",
|
423
776
|
# })
|
424
777
|
#
|
425
778
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/EnableRule AWS API Documentation
|
@@ -431,13 +784,220 @@ module Aws::CloudWatchEvents
|
|
431
784
|
req.send_request(options)
|
432
785
|
end
|
433
786
|
|
434
|
-
# Lists the
|
435
|
-
#
|
436
|
-
#
|
787
|
+
# Lists all the event buses in your account, including the default event
|
788
|
+
# bus, custom event buses, and partner event buses.
|
789
|
+
#
|
790
|
+
# <note markdown="1"> This operation is run by AWS customers, not by SaaS partners.
|
791
|
+
#
|
792
|
+
# </note>
|
793
|
+
#
|
794
|
+
# @option params [String] :name_prefix
|
795
|
+
# Specifying this limits the results to only those event buses with
|
796
|
+
# names that start with the specified prefix.
|
797
|
+
#
|
798
|
+
# @option params [String] :next_token
|
799
|
+
# The token returned by a previous call to retrieve the next set of
|
800
|
+
# results.
|
801
|
+
#
|
802
|
+
# @option params [Integer] :limit
|
803
|
+
# 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.
|
806
|
+
#
|
807
|
+
# @return [Types::ListEventBusesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
808
|
+
#
|
809
|
+
# * {Types::ListEventBusesResponse#event_buses #event_buses} => Array<Types::EventBus>
|
810
|
+
# * {Types::ListEventBusesResponse#next_token #next_token} => String
|
811
|
+
#
|
812
|
+
# @example Request syntax with placeholder values
|
813
|
+
#
|
814
|
+
# resp = client.list_event_buses({
|
815
|
+
# name_prefix: "EventBusName",
|
816
|
+
# next_token: "NextToken",
|
817
|
+
# limit: 1,
|
818
|
+
# })
|
819
|
+
#
|
820
|
+
# @example Response structure
|
821
|
+
#
|
822
|
+
# resp.event_buses #=> Array
|
823
|
+
# resp.event_buses[0].name #=> String
|
824
|
+
# resp.event_buses[0].arn #=> String
|
825
|
+
# resp.event_buses[0].policy #=> String
|
826
|
+
# resp.next_token #=> String
|
827
|
+
#
|
828
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListEventBuses AWS API Documentation
|
829
|
+
#
|
830
|
+
# @overload list_event_buses(params = {})
|
831
|
+
# @param [Hash] params ({})
|
832
|
+
def list_event_buses(params = {}, options = {})
|
833
|
+
req = build_request(:list_event_buses, params)
|
834
|
+
req.send_request(options)
|
835
|
+
end
|
836
|
+
|
837
|
+
# You can use this to see all the partner event sources that have been
|
838
|
+
# shared with your AWS account. For more information about partner event
|
839
|
+
# sources, see CreateEventBus.
|
840
|
+
#
|
841
|
+
# <note markdown="1"> This operation is run by AWS customers, not by SaaS partners.
|
842
|
+
#
|
843
|
+
# </note>
|
844
|
+
#
|
845
|
+
# @option params [String] :name_prefix
|
846
|
+
# Specifying this limits the results to only those partner event sources
|
847
|
+
# with names that start with the specified prefix.
|
848
|
+
#
|
849
|
+
# @option params [String] :next_token
|
850
|
+
# The token returned by a previous call to retrieve the next set of
|
851
|
+
# results.
|
852
|
+
#
|
853
|
+
# @option params [Integer] :limit
|
854
|
+
# 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.
|
857
|
+
#
|
858
|
+
# @return [Types::ListEventSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
859
|
+
#
|
860
|
+
# * {Types::ListEventSourcesResponse#event_sources #event_sources} => Array<Types::EventSource>
|
861
|
+
# * {Types::ListEventSourcesResponse#next_token #next_token} => String
|
862
|
+
#
|
863
|
+
# @example Request syntax with placeholder values
|
864
|
+
#
|
865
|
+
# resp = client.list_event_sources({
|
866
|
+
# name_prefix: "EventSourceNamePrefix",
|
867
|
+
# next_token: "NextToken",
|
868
|
+
# limit: 1,
|
869
|
+
# })
|
870
|
+
#
|
871
|
+
# @example Response structure
|
872
|
+
#
|
873
|
+
# resp.event_sources #=> Array
|
874
|
+
# resp.event_sources[0].arn #=> String
|
875
|
+
# resp.event_sources[0].created_by #=> String
|
876
|
+
# resp.event_sources[0].creation_time #=> Time
|
877
|
+
# resp.event_sources[0].expiration_time #=> Time
|
878
|
+
# resp.event_sources[0].name #=> String
|
879
|
+
# resp.event_sources[0].state #=> String, one of "PENDING", "ACTIVE", "DELETED"
|
880
|
+
# resp.next_token #=> String
|
881
|
+
#
|
882
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListEventSources AWS API Documentation
|
883
|
+
#
|
884
|
+
# @overload list_event_sources(params = {})
|
885
|
+
# @param [Hash] params ({})
|
886
|
+
def list_event_sources(params = {}, options = {})
|
887
|
+
req = build_request(:list_event_sources, params)
|
888
|
+
req.send_request(options)
|
889
|
+
end
|
890
|
+
|
891
|
+
# 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>
|
897
|
+
#
|
898
|
+
# @option params [required, String] :event_source_name
|
899
|
+
# The name of the partner event source to display account information
|
900
|
+
# about.
|
901
|
+
#
|
902
|
+
# @option params [String] :next_token
|
903
|
+
# The token returned by a previous call to this operation. Specifying
|
904
|
+
# this retrieves the next set of results.
|
905
|
+
#
|
906
|
+
# @option params [Integer] :limit
|
907
|
+
# 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.
|
910
|
+
#
|
911
|
+
# @return [Types::ListPartnerEventSourceAccountsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
912
|
+
#
|
913
|
+
# * {Types::ListPartnerEventSourceAccountsResponse#partner_event_source_accounts #partner_event_source_accounts} => Array<Types::PartnerEventSourceAccount>
|
914
|
+
# * {Types::ListPartnerEventSourceAccountsResponse#next_token #next_token} => String
|
915
|
+
#
|
916
|
+
# @example Request syntax with placeholder values
|
917
|
+
#
|
918
|
+
# resp = client.list_partner_event_source_accounts({
|
919
|
+
# event_source_name: "EventSourceName", # required
|
920
|
+
# next_token: "NextToken",
|
921
|
+
# limit: 1,
|
922
|
+
# })
|
923
|
+
#
|
924
|
+
# @example Response structure
|
925
|
+
#
|
926
|
+
# resp.partner_event_source_accounts #=> Array
|
927
|
+
# resp.partner_event_source_accounts[0].account #=> String
|
928
|
+
# resp.partner_event_source_accounts[0].creation_time #=> Time
|
929
|
+
# resp.partner_event_source_accounts[0].expiration_time #=> Time
|
930
|
+
# resp.partner_event_source_accounts[0].state #=> String, one of "PENDING", "ACTIVE", "DELETED"
|
931
|
+
# resp.next_token #=> String
|
932
|
+
#
|
933
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListPartnerEventSourceAccounts AWS API Documentation
|
934
|
+
#
|
935
|
+
# @overload list_partner_event_source_accounts(params = {})
|
936
|
+
# @param [Hash] params ({})
|
937
|
+
def list_partner_event_source_accounts(params = {}, options = {})
|
938
|
+
req = build_request(:list_partner_event_source_accounts, params)
|
939
|
+
req.send_request(options)
|
940
|
+
end
|
941
|
+
|
942
|
+
# 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>
|
948
|
+
#
|
949
|
+
# @option params [required, String] :name_prefix
|
950
|
+
# If you specify this, the results are limited to only those partner
|
951
|
+
# event sources that start with the string you specify.
|
952
|
+
#
|
953
|
+
# @option params [String] :next_token
|
954
|
+
# The token returned by a previous call to this operation. Specifying
|
955
|
+
# this retrieves the next set of results.
|
956
|
+
#
|
957
|
+
# @option params [Integer] :limit
|
958
|
+
# 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.
|
961
|
+
#
|
962
|
+
# @return [Types::ListPartnerEventSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
963
|
+
#
|
964
|
+
# * {Types::ListPartnerEventSourcesResponse#partner_event_sources #partner_event_sources} => Array<Types::PartnerEventSource>
|
965
|
+
# * {Types::ListPartnerEventSourcesResponse#next_token #next_token} => String
|
966
|
+
#
|
967
|
+
# @example Request syntax with placeholder values
|
968
|
+
#
|
969
|
+
# resp = client.list_partner_event_sources({
|
970
|
+
# name_prefix: "PartnerEventSourceNamePrefix", # required
|
971
|
+
# next_token: "NextToken",
|
972
|
+
# limit: 1,
|
973
|
+
# })
|
974
|
+
#
|
975
|
+
# @example Response structure
|
976
|
+
#
|
977
|
+
# resp.partner_event_sources #=> Array
|
978
|
+
# resp.partner_event_sources[0].arn #=> String
|
979
|
+
# resp.partner_event_sources[0].name #=> String
|
980
|
+
# resp.next_token #=> String
|
981
|
+
#
|
982
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListPartnerEventSources AWS API Documentation
|
983
|
+
#
|
984
|
+
# @overload list_partner_event_sources(params = {})
|
985
|
+
# @param [Hash] params ({})
|
986
|
+
def list_partner_event_sources(params = {}, options = {})
|
987
|
+
req = build_request(:list_partner_event_sources, params)
|
988
|
+
req.send_request(options)
|
989
|
+
end
|
990
|
+
|
991
|
+
# Lists the rules for the specified target. You can see which rules can
|
992
|
+
# invoke a specific target in your account.
|
437
993
|
#
|
438
994
|
# @option params [required, String] :target_arn
|
439
995
|
# The Amazon Resource Name (ARN) of the target resource.
|
440
996
|
#
|
997
|
+
# @option params [String] :event_bus_name
|
998
|
+
# Limits the results to show only the rules associated with the
|
999
|
+
# specified event bus.
|
1000
|
+
#
|
441
1001
|
# @option params [String] :next_token
|
442
1002
|
# The token returned by a previous call to retrieve the next set of
|
443
1003
|
# results.
|
@@ -454,6 +1014,7 @@ module Aws::CloudWatchEvents
|
|
454
1014
|
#
|
455
1015
|
# resp = client.list_rule_names_by_target({
|
456
1016
|
# target_arn: "TargetArn", # required
|
1017
|
+
# event_bus_name: "EventBusName",
|
457
1018
|
# next_token: "NextToken",
|
458
1019
|
# limit: 1,
|
459
1020
|
# })
|
@@ -473,15 +1034,19 @@ module Aws::CloudWatchEvents
|
|
473
1034
|
req.send_request(options)
|
474
1035
|
end
|
475
1036
|
|
476
|
-
# Lists your
|
477
|
-
#
|
1037
|
+
# Lists your EventBridge rules. You can either list all the rules or
|
1038
|
+
# provide a prefix to match to the rule names.
|
478
1039
|
#
|
479
|
-
# ListRules
|
1040
|
+
# `ListRules` doesn't list the targets of a rule. To see the targets
|
480
1041
|
# associated with a rule, use ListTargetsByRule.
|
481
1042
|
#
|
482
1043
|
# @option params [String] :name_prefix
|
483
1044
|
# The prefix matching the rule name.
|
484
1045
|
#
|
1046
|
+
# @option params [String] :event_bus_name
|
1047
|
+
# Limits the results to show only the rules associated with the
|
1048
|
+
# specified event bus.
|
1049
|
+
#
|
485
1050
|
# @option params [String] :next_token
|
486
1051
|
# The token returned by a previous call to retrieve the next set of
|
487
1052
|
# results.
|
@@ -498,6 +1063,7 @@ module Aws::CloudWatchEvents
|
|
498
1063
|
#
|
499
1064
|
# resp = client.list_rules({
|
500
1065
|
# name_prefix: "RuleName",
|
1066
|
+
# event_bus_name: "EventBusName",
|
501
1067
|
# next_token: "NextToken",
|
502
1068
|
# limit: 1,
|
503
1069
|
# })
|
@@ -513,6 +1079,7 @@ module Aws::CloudWatchEvents
|
|
513
1079
|
# resp.rules[0].schedule_expression #=> String
|
514
1080
|
# resp.rules[0].role_arn #=> String
|
515
1081
|
# resp.rules[0].managed_by #=> String
|
1082
|
+
# resp.rules[0].event_bus_name #=> String
|
516
1083
|
# resp.next_token #=> String
|
517
1084
|
#
|
518
1085
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListRules AWS API Documentation
|
@@ -524,11 +1091,11 @@ module Aws::CloudWatchEvents
|
|
524
1091
|
req.send_request(options)
|
525
1092
|
end
|
526
1093
|
|
527
|
-
# Displays the tags associated with
|
528
|
-
#
|
1094
|
+
# Displays the tags associated with an EventBridge resource. In
|
1095
|
+
# EventBridge, rules can be tagged.
|
529
1096
|
#
|
530
1097
|
# @option params [required, String] :resource_arn
|
531
|
-
# The ARN of the
|
1098
|
+
# The ARN of the rule for which you want to view tags.
|
532
1099
|
#
|
533
1100
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
534
1101
|
#
|
@@ -560,6 +1127,10 @@ module Aws::CloudWatchEvents
|
|
560
1127
|
# @option params [required, String] :rule
|
561
1128
|
# The name of the rule.
|
562
1129
|
#
|
1130
|
+
# @option params [String] :event_bus_name
|
1131
|
+
# The event bus associated with the rule. If you omit this, the default
|
1132
|
+
# event bus is used.
|
1133
|
+
#
|
563
1134
|
# @option params [String] :next_token
|
564
1135
|
# The token returned by a previous call to retrieve the next set of
|
565
1136
|
# results.
|
@@ -576,6 +1147,7 @@ module Aws::CloudWatchEvents
|
|
576
1147
|
#
|
577
1148
|
# resp = client.list_targets_by_rule({
|
578
1149
|
# rule: "RuleName", # required
|
1150
|
+
# event_bus_name: "EventBusName",
|
579
1151
|
# next_token: "NextToken",
|
580
1152
|
# limit: 1,
|
581
1153
|
# })
|
@@ -622,8 +1194,8 @@ module Aws::CloudWatchEvents
|
|
622
1194
|
req.send_request(options)
|
623
1195
|
end
|
624
1196
|
|
625
|
-
# Sends custom events to
|
626
|
-
#
|
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.
|
627
1199
|
#
|
628
1200
|
# @option params [required, Array<Types::PutEventsRequestEntry>] :entries
|
629
1201
|
# The entry that defines an event in your system. You can specify
|
@@ -645,6 +1217,7 @@ module Aws::CloudWatchEvents
|
|
645
1217
|
# resources: ["EventResource"],
|
646
1218
|
# detail_type: "String",
|
647
1219
|
# detail: "String",
|
1220
|
+
# event_bus_name: "NonPartnerEventBusName",
|
648
1221
|
# },
|
649
1222
|
# ],
|
650
1223
|
# })
|
@@ -666,18 +1239,65 @@ module Aws::CloudWatchEvents
|
|
666
1239
|
req.send_request(options)
|
667
1240
|
end
|
668
1241
|
|
1242
|
+
# 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>
|
1250
|
+
#
|
1251
|
+
# @option params [required, Array<Types::PutPartnerEventsRequestEntry>] :entries
|
1252
|
+
# The list of events to write to the event bus.
|
1253
|
+
#
|
1254
|
+
# @return [Types::PutPartnerEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1255
|
+
#
|
1256
|
+
# * {Types::PutPartnerEventsResponse#failed_entry_count #failed_entry_count} => Integer
|
1257
|
+
# * {Types::PutPartnerEventsResponse#entries #entries} => Array<Types::PutPartnerEventsResultEntry>
|
1258
|
+
#
|
1259
|
+
# @example Request syntax with placeholder values
|
1260
|
+
#
|
1261
|
+
# resp = client.put_partner_events({
|
1262
|
+
# entries: [ # required
|
1263
|
+
# {
|
1264
|
+
# time: Time.now,
|
1265
|
+
# source: "String",
|
1266
|
+
# resources: ["EventResource"],
|
1267
|
+
# detail_type: "String",
|
1268
|
+
# detail: "String",
|
1269
|
+
# },
|
1270
|
+
# ],
|
1271
|
+
# })
|
1272
|
+
#
|
1273
|
+
# @example Response structure
|
1274
|
+
#
|
1275
|
+
# resp.failed_entry_count #=> Integer
|
1276
|
+
# resp.entries #=> Array
|
1277
|
+
# resp.entries[0].event_id #=> String
|
1278
|
+
# resp.entries[0].error_code #=> String
|
1279
|
+
# resp.entries[0].error_message #=> String
|
1280
|
+
#
|
1281
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutPartnerEvents AWS API Documentation
|
1282
|
+
#
|
1283
|
+
# @overload put_partner_events(params = {})
|
1284
|
+
# @param [Hash] params ({})
|
1285
|
+
def put_partner_events(params = {}, options = {})
|
1286
|
+
req = build_request(:put_partner_events, params)
|
1287
|
+
req.send_request(options)
|
1288
|
+
end
|
1289
|
+
|
669
1290
|
# Running `PutPermission` permits the specified AWS account or AWS
|
670
|
-
# organization to put events to
|
671
|
-
#
|
672
|
-
#
|
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.
|
673
1294
|
#
|
674
1295
|
# For another account to send events to your account, that external
|
675
|
-
# account must have a
|
676
|
-
# default event bus as a target.
|
1296
|
+
# account must have a rule with your account's event bus as a target.
|
677
1297
|
#
|
678
|
-
# To enable multiple AWS accounts to put events to
|
679
|
-
#
|
680
|
-
#
|
1298
|
+
# To enable multiple AWS accounts to put events to an event bus, run
|
1299
|
+
# `PutPermission` once for each of these accounts. Or, if all the
|
1300
|
+
# accounts are members of the same AWS organization, you can run
|
681
1301
|
# `PutPermission` once specifying `Principal` as "*" and specifying
|
682
1302
|
# the AWS organization ID in `Condition`, to grant permissions to all
|
683
1303
|
# accounts in that organization.
|
@@ -686,17 +1306,20 @@ module Aws::CloudWatchEvents
|
|
686
1306
|
# organization must specify a `RoleArn` with proper permissions when
|
687
1307
|
# they use `PutTarget` to add your account's event bus as a target. For
|
688
1308
|
# more information, see [Sending and Receiving Events Between AWS
|
689
|
-
# Accounts][1] in the *Amazon
|
1309
|
+
# Accounts][1] in the *Amazon EventBridge User Guide*.
|
690
1310
|
#
|
691
|
-
# The permission policy on
|
692
|
-
# size.
|
1311
|
+
# The permission policy on an event bus can't exceed 10 KB in size.
|
693
1312
|
#
|
694
1313
|
#
|
695
1314
|
#
|
696
|
-
# [1]: https://docs.aws.amazon.com/
|
1315
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
|
1316
|
+
#
|
1317
|
+
# @option params [String] :event_bus_name
|
1318
|
+
# The event bus associated with the rule. If you omit this, the default
|
1319
|
+
# event bus is used.
|
697
1320
|
#
|
698
1321
|
# @option params [required, String] :action
|
699
|
-
# The action that you
|
1322
|
+
# The action that you're enabling the other account to perform.
|
700
1323
|
# Currently, this must be `events:PutEvents`.
|
701
1324
|
#
|
702
1325
|
# @option params [required, String] :principal
|
@@ -705,14 +1328,14 @@ module Aws::CloudWatchEvents
|
|
705
1328
|
# events to your default event bus.
|
706
1329
|
#
|
707
1330
|
# If you specify "*" without specifying `Condition`, avoid creating
|
708
|
-
# rules that
|
709
|
-
# make sure that the event pattern for each rule contains an
|
710
|
-
# field with a specific account ID
|
711
|
-
# with an account field
|
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
|
712
1335
|
# accounts.
|
713
1336
|
#
|
714
1337
|
# @option params [required, String] :statement_id
|
715
|
-
# An identifier string for the external account that you
|
1338
|
+
# An identifier string for the external account that you're granting
|
716
1339
|
# permissions to. If you later want to revoke the permission for this
|
717
1340
|
# external account, specify this `StatementId` when you run
|
718
1341
|
# RemovePermission.
|
@@ -721,13 +1344,13 @@ module Aws::CloudWatchEvents
|
|
721
1344
|
# This parameter enables you to limit the permission to accounts that
|
722
1345
|
# fulfill a certain condition, such as being a member of a certain AWS
|
723
1346
|
# organization. For more information about AWS Organizations, see [What
|
724
|
-
# Is AWS Organizations][1] in the *AWS Organizations User Guide*.
|
1347
|
+
# Is AWS Organizations?][1] in the *AWS Organizations User Guide*.
|
725
1348
|
#
|
726
|
-
# If you specify `Condition` with an AWS organization ID
|
1349
|
+
# If you specify `Condition` with an AWS organization ID and specify
|
727
1350
|
# "*" as the value for `Principal`, you grant permission to all the
|
728
1351
|
# accounts in the named organization.
|
729
1352
|
#
|
730
|
-
# The `Condition` is a JSON string
|
1353
|
+
# The `Condition` is a JSON string that must contain `Type`, `Key`, and
|
731
1354
|
# `Value` fields.
|
732
1355
|
#
|
733
1356
|
#
|
@@ -739,6 +1362,7 @@ module Aws::CloudWatchEvents
|
|
739
1362
|
# @example Request syntax with placeholder values
|
740
1363
|
#
|
741
1364
|
# resp = client.put_permission({
|
1365
|
+
# event_bus_name: "NonPartnerEventBusName",
|
742
1366
|
# action: "Action", # required
|
743
1367
|
# principal: "Principal", # required
|
744
1368
|
# statement_id: "StatementId", # required
|
@@ -758,25 +1382,32 @@ module Aws::CloudWatchEvents
|
|
758
1382
|
req.send_request(options)
|
759
1383
|
end
|
760
1384
|
|
761
|
-
# Creates or updates the specified rule. Rules are enabled by default
|
762
|
-
#
|
763
|
-
#
|
764
|
-
#
|
765
|
-
#
|
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.
|
1387
|
+
#
|
1388
|
+
# A single rule watches for events from a single event bus. Events
|
1389
|
+
# generated by AWS services go to your account's default event bus.
|
1390
|
+
# Events generated by SaaS partner services or applications go to the
|
1391
|
+
# matching partner event bus. If you have custom applications or
|
1392
|
+
# services, you can specify whether their events go to your default
|
1393
|
+
# event bus or a custom event bus that you have created. For more
|
1394
|
+
# information, see CreateEventBus.
|
1395
|
+
#
|
1396
|
+
# If you're updating an existing rule, the rule is replaced with what
|
766
1397
|
# you specify in this `PutRule` command. If you omit arguments in
|
767
|
-
# `PutRule`, the old values for those arguments
|
768
|
-
# they
|
1398
|
+
# `PutRule`, the old values for those arguments aren't kept. Instead,
|
1399
|
+
# they're replaced with null values.
|
769
1400
|
#
|
770
1401
|
# When you create or update a rule, incoming events might not
|
771
1402
|
# immediately start matching to new or updated rules. Allow a short
|
772
1403
|
# period of time for changes to take effect.
|
773
1404
|
#
|
774
|
-
# A rule must contain at least an EventPattern or
|
775
|
-
# Rules with EventPatterns are triggered when a
|
776
|
-
# observed. Rules with ScheduleExpressions
|
777
|
-
# given schedule. A rule can have both an
|
778
|
-
# ScheduleExpression
|
779
|
-
# as well as on a schedule.
|
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.
|
780
1411
|
#
|
781
1412
|
# When you initially create a rule, you can optionally assign one or
|
782
1413
|
# more tags to the rule. Tags can help you organize and categorize your
|
@@ -789,21 +1420,21 @@ module Aws::CloudWatchEvents
|
|
789
1420
|
# `PutRule` operation are ignored. To update the tags of an existing
|
790
1421
|
# rule, use TagResource and UntagResource.
|
791
1422
|
#
|
792
|
-
# Most services in AWS treat
|
793
|
-
# Resource Names (ARNs). However,
|
794
|
-
#
|
1423
|
+
# Most services in AWS treat `:` or `/` as the same character in Amazon
|
1424
|
+
# Resource Names (ARNs). However, EventBridge uses an exact match in
|
1425
|
+
# event patterns and rules. Be sure to use the correct ARN characters
|
795
1426
|
# when creating event patterns so that they match the ARN syntax in the
|
796
|
-
# event you want to match.
|
1427
|
+
# event that you want to match.
|
797
1428
|
#
|
798
|
-
# In
|
799
|
-
#
|
800
|
-
#
|
801
|
-
#
|
802
|
-
#
|
803
|
-
#
|
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.
|
804
1435
|
#
|
805
|
-
# To prevent this, write the rules so that the triggered actions
|
806
|
-
#
|
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
|
807
1438
|
# are found to be in a bad state, instead of after any change.
|
808
1439
|
#
|
809
1440
|
# An infinite loop can quickly cause higher than expected charges. We
|
@@ -816,19 +1447,19 @@ module Aws::CloudWatchEvents
|
|
816
1447
|
# [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html
|
817
1448
|
#
|
818
1449
|
# @option params [required, String] :name
|
819
|
-
# The name of the rule that you
|
1450
|
+
# The name of the rule that you're creating or updating.
|
820
1451
|
#
|
821
1452
|
# @option params [String] :schedule_expression
|
822
|
-
# The scheduling expression
|
823
|
-
# "rate(5 minutes)"
|
1453
|
+
# The scheduling expression: for example, `"cron(0 20 * * ? *)"` or
|
1454
|
+
# `"rate(5 minutes)"`.
|
824
1455
|
#
|
825
1456
|
# @option params [String] :event_pattern
|
826
|
-
# The event pattern. For more information, see [
|
827
|
-
#
|
1457
|
+
# The event pattern. For more information, see [Event Patterns][1] in
|
1458
|
+
# the *Amazon EventBridge User Guide*.
|
828
1459
|
#
|
829
1460
|
#
|
830
1461
|
#
|
831
|
-
# [1]: https://docs.aws.amazon.com/
|
1462
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
|
832
1463
|
#
|
833
1464
|
# @option params [String] :state
|
834
1465
|
# Indicates whether the rule is enabled or disabled.
|
@@ -843,6 +1474,10 @@ module Aws::CloudWatchEvents
|
|
843
1474
|
# @option params [Array<Types::Tag>] :tags
|
844
1475
|
# The list of key-value pairs to associate with the rule.
|
845
1476
|
#
|
1477
|
+
# @option params [String] :event_bus_name
|
1478
|
+
# The event bus to associate with this rule. If you omit this, the
|
1479
|
+
# default event bus is used.
|
1480
|
+
#
|
846
1481
|
# @return [Types::PutRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
847
1482
|
#
|
848
1483
|
# * {Types::PutRuleResponse#rule_arn #rule_arn} => String
|
@@ -862,6 +1497,7 @@ module Aws::CloudWatchEvents
|
|
862
1497
|
# value: "TagValue", # required
|
863
1498
|
# },
|
864
1499
|
# ],
|
1500
|
+
# event_bus_name: "EventBusName",
|
865
1501
|
# })
|
866
1502
|
#
|
867
1503
|
# @example Response structure
|
@@ -878,11 +1514,11 @@ module Aws::CloudWatchEvents
|
|
878
1514
|
end
|
879
1515
|
|
880
1516
|
# Adds the specified targets to the specified rule, or updates the
|
881
|
-
# targets if they
|
1517
|
+
# targets if they're already associated with the rule.
|
882
1518
|
#
|
883
1519
|
# Targets are the resources that are invoked when a rule is triggered.
|
884
1520
|
#
|
885
|
-
# You can configure the following as targets
|
1521
|
+
# You can configure the following as targets in EventBridge:
|
886
1522
|
#
|
887
1523
|
# * EC2 instances
|
888
1524
|
#
|
@@ -914,7 +1550,7 @@ module Aws::CloudWatchEvents
|
|
914
1550
|
#
|
915
1551
|
# * The default event bus of another AWS account
|
916
1552
|
#
|
917
|
-
# Creating rules with built-in targets is supported only
|
1553
|
+
# Creating rules with built-in targets is supported only on the AWS
|
918
1554
|
# Management Console. The built-in targets are `EC2 CreateSnapshot API
|
919
1555
|
# call`, `EC2 RebootInstances API call`, `EC2 StopInstances API call`,
|
920
1556
|
# and `EC2 TerminateInstances API call`.
|
@@ -926,15 +1562,15 @@ module Aws::CloudWatchEvents
|
|
926
1562
|
# you can use the `RunCommandParameters` field.
|
927
1563
|
#
|
928
1564
|
# To be able to make API calls against the resources that you own,
|
929
|
-
# Amazon
|
930
|
-
#
|
931
|
-
#
|
932
|
-
#
|
933
|
-
#
|
934
|
-
#
|
935
|
-
#
|
936
|
-
#
|
937
|
-
# If another AWS account is in the same
|
1565
|
+
# Amazon EventBridge needs the appropriate permissions. For AWS Lambda
|
1566
|
+
# and Amazon SNS resources, EventBridge relies on resource-based
|
1567
|
+
# policies. For EC2 instances, Kinesis data streams, and AWS Step
|
1568
|
+
# Functions state machines, EventBridge relies on IAM roles that you
|
1569
|
+
# specify in the `RoleARN` argument in `PutTargets`. For more
|
1570
|
+
# information, see [Authentication and Access Control][1] in the *Amazon
|
1571
|
+
# EventBridge User Guide*.
|
1572
|
+
#
|
1573
|
+
# If another AWS account is in the same Region and has granted you
|
938
1574
|
# permission (using `PutPermission`), you can send events to that
|
939
1575
|
# account. Set that account's event bus as a target of the rules in
|
940
1576
|
# your account. To send the matched events to the other account, specify
|
@@ -942,39 +1578,39 @@ module Aws::CloudWatchEvents
|
|
942
1578
|
# `PutTargets`. If your account sends events to another account, your
|
943
1579
|
# account is charged for each sent event. Each event sent to another
|
944
1580
|
# account is charged as a custom event. The account receiving the event
|
945
|
-
#
|
1581
|
+
# isn't charged. For more information, see [Amazon EventBridge
|
946
1582
|
# Pricing][2].
|
947
1583
|
#
|
948
|
-
# If you
|
1584
|
+
# If you're setting an event bus in another account as the target and
|
949
1585
|
# that account granted permission to your account through an
|
950
|
-
# organization instead of directly by the account ID,
|
951
|
-
#
|
952
|
-
#
|
953
|
-
# Accounts][3] in the *Amazon
|
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
|
1589
|
+
# Accounts][3] in the *Amazon EventBridge User Guide*.
|
954
1590
|
#
|
955
1591
|
# For more information about enabling cross-account events, see
|
956
1592
|
# PutPermission.
|
957
1593
|
#
|
958
|
-
#
|
959
|
-
#
|
960
|
-
#
|
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:
|
961
1597
|
#
|
962
|
-
# * If none of the following arguments are specified for a target,
|
963
|
-
#
|
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
|
964
1600
|
# target is Amazon EC2 Run Command or Amazon ECS task, in which case
|
965
1601
|
# nothing from the event is passed to the target).
|
966
1602
|
#
|
967
|
-
# * If
|
968
|
-
#
|
1603
|
+
# * If `Input` is specified in the form of valid JSON, then the matched
|
1604
|
+
# event is overridden with this constant.
|
969
1605
|
#
|
970
|
-
# * If
|
971
|
-
# `$.detail`),
|
972
|
-
#
|
973
|
-
#
|
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).
|
974
1610
|
#
|
975
|
-
# * If
|
976
|
-
#
|
977
|
-
#
|
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.
|
978
1614
|
#
|
979
1615
|
# When you specify `InputPath` or `InputTransformer`, you must use JSON
|
980
1616
|
# dot notation, not bracket notation.
|
@@ -984,19 +1620,23 @@ module Aws::CloudWatchEvents
|
|
984
1620
|
# a short period of time for changes to take effect.
|
985
1621
|
#
|
986
1622
|
# This action can partially fail if too many requests are made at the
|
987
|
-
# same time. If that happens, `FailedEntryCount` is
|
988
|
-
# response and each entry in `FailedEntries` provides the ID of the
|
1623
|
+
# same time. If that happens, `FailedEntryCount` is nonzero in the
|
1624
|
+
# response, and each entry in `FailedEntries` provides the ID of the
|
989
1625
|
# failed target and the error code.
|
990
1626
|
#
|
991
1627
|
#
|
992
1628
|
#
|
993
|
-
# [1]: https://docs.aws.amazon.com/
|
994
|
-
# [2]: https://aws.amazon.com/
|
995
|
-
# [3]: https://docs.aws.amazon.com/
|
1629
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html
|
1630
|
+
# [2]: https://aws.amazon.com/eventbridge/pricing/
|
1631
|
+
# [3]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
|
996
1632
|
#
|
997
1633
|
# @option params [required, String] :rule
|
998
1634
|
# The name of the rule.
|
999
1635
|
#
|
1636
|
+
# @option params [String] :event_bus_name
|
1637
|
+
# The name of the event bus associated with the rule. If you omit this,
|
1638
|
+
# the default event bus is used.
|
1639
|
+
#
|
1000
1640
|
# @option params [required, Array<Types::Target>] :targets
|
1001
1641
|
# The targets to update or add to the rule.
|
1002
1642
|
#
|
@@ -1009,6 +1649,7 @@ module Aws::CloudWatchEvents
|
|
1009
1649
|
#
|
1010
1650
|
# resp = client.put_targets({
|
1011
1651
|
# rule: "RuleName", # required
|
1652
|
+
# event_bus_name: "EventBusName",
|
1012
1653
|
# targets: [ # required
|
1013
1654
|
# {
|
1014
1655
|
# id: "TargetId", # required
|
@@ -1082,7 +1723,7 @@ module Aws::CloudWatchEvents
|
|
1082
1723
|
end
|
1083
1724
|
|
1084
1725
|
# Revokes the permission of another AWS account to be able to put events
|
1085
|
-
# to
|
1726
|
+
# to the specified event bus. Specify the account to revoke by the
|
1086
1727
|
# `StatementId` value that you associated with the account when you
|
1087
1728
|
# granted it permission with `PutPermission`. You can find the
|
1088
1729
|
# `StatementId` by using DescribeEventBus.
|
@@ -1091,12 +1732,17 @@ module Aws::CloudWatchEvents
|
|
1091
1732
|
# The statement ID corresponding to the account that is no longer
|
1092
1733
|
# allowed to put events to the default event bus.
|
1093
1734
|
#
|
1735
|
+
# @option params [String] :event_bus_name
|
1736
|
+
# The name of the event bus to revoke permissions for. If you omit this,
|
1737
|
+
# the default event bus is used.
|
1738
|
+
#
|
1094
1739
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1095
1740
|
#
|
1096
1741
|
# @example Request syntax with placeholder values
|
1097
1742
|
#
|
1098
1743
|
# resp = client.remove_permission({
|
1099
1744
|
# statement_id: "StatementId", # required
|
1745
|
+
# event_bus_name: "NonPartnerEventBusName",
|
1100
1746
|
# })
|
1101
1747
|
#
|
1102
1748
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/RemovePermission AWS API Documentation
|
@@ -1123,13 +1769,16 @@ module Aws::CloudWatchEvents
|
|
1123
1769
|
# @option params [required, String] :rule
|
1124
1770
|
# The name of the rule.
|
1125
1771
|
#
|
1772
|
+
# @option params [String] :event_bus_name
|
1773
|
+
# The name of the event bus associated with the rule.
|
1774
|
+
#
|
1126
1775
|
# @option params [required, Array<String>] :ids
|
1127
1776
|
# The IDs of the targets to remove from the rule.
|
1128
1777
|
#
|
1129
1778
|
# @option params [Boolean] :force
|
1130
|
-
# If this is a managed rule
|
1779
|
+
# If this is a managed rule created by an AWS service on your behalf,
|
1131
1780
|
# you must specify `Force` as `True` to remove targets. This parameter
|
1132
|
-
# is ignored for rules that
|
1781
|
+
# is ignored for rules that aren't managed rules. You can check whether
|
1133
1782
|
# a rule is a managed rule by using `DescribeRule` or `ListRules` and
|
1134
1783
|
# checking the `ManagedBy` field of the response.
|
1135
1784
|
#
|
@@ -1142,6 +1791,7 @@ module Aws::CloudWatchEvents
|
|
1142
1791
|
#
|
1143
1792
|
# resp = client.remove_targets({
|
1144
1793
|
# rule: "RuleName", # required
|
1794
|
+
# event_bus_name: "EventBusName",
|
1145
1795
|
# ids: ["TargetId"], # required
|
1146
1796
|
# force: false,
|
1147
1797
|
# })
|
@@ -1163,11 +1813,11 @@ module Aws::CloudWatchEvents
|
|
1163
1813
|
req.send_request(options)
|
1164
1814
|
end
|
1165
1815
|
|
1166
|
-
# Assigns one or more tags (key-value pairs) to the specified
|
1167
|
-
#
|
1816
|
+
# Assigns one or more tags (key-value pairs) to the specified
|
1817
|
+
# EventBridge resource. Tags can help you organize and categorize your
|
1168
1818
|
# resources. You can also use them to scope user permissions by granting
|
1169
1819
|
# a user permission to access or change only resources with certain tag
|
1170
|
-
# values. In
|
1820
|
+
# values. In EventBridge, rules can be tagged.
|
1171
1821
|
#
|
1172
1822
|
# Tags don't have any semantic meaning to AWS and are interpreted
|
1173
1823
|
# strictly as strings of characters.
|
@@ -1181,7 +1831,7 @@ module Aws::CloudWatchEvents
|
|
1181
1831
|
# You can associate as many as 50 tags with a resource.
|
1182
1832
|
#
|
1183
1833
|
# @option params [required, String] :resource_arn
|
1184
|
-
# The ARN of the
|
1834
|
+
# The ARN of the rule that you're adding tags to.
|
1185
1835
|
#
|
1186
1836
|
# @option params [required, Array<Types::Tag>] :tags
|
1187
1837
|
# The list of key-value pairs to associate with the rule.
|
@@ -1211,19 +1861,19 @@ module Aws::CloudWatchEvents
|
|
1211
1861
|
|
1212
1862
|
# Tests whether the specified event pattern matches the provided event.
|
1213
1863
|
#
|
1214
|
-
# Most services in AWS treat
|
1215
|
-
# Resource Names (ARNs). However,
|
1216
|
-
#
|
1864
|
+
# Most services in AWS treat `:` or `/` as the same character in Amazon
|
1865
|
+
# Resource Names (ARNs). However, EventBridge uses an exact match in
|
1866
|
+
# event patterns and rules. Be sure to use the correct ARN characters
|
1217
1867
|
# when creating event patterns so that they match the ARN syntax in the
|
1218
|
-
# event you want to match.
|
1868
|
+
# event that you want to match.
|
1219
1869
|
#
|
1220
1870
|
# @option params [required, String] :event_pattern
|
1221
|
-
# The event pattern. For more information, see [
|
1222
|
-
#
|
1871
|
+
# The event pattern. For more information, see [Event Patterns][1] in
|
1872
|
+
# the *Amazon EventBridge User Guide*.
|
1223
1873
|
#
|
1224
1874
|
#
|
1225
1875
|
#
|
1226
|
-
# [1]: https://docs.aws.amazon.com/
|
1876
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
|
1227
1877
|
#
|
1228
1878
|
# @option params [required, String] :event
|
1229
1879
|
# The event, in JSON format, to test against the event pattern.
|
@@ -1252,12 +1902,11 @@ module Aws::CloudWatchEvents
|
|
1252
1902
|
req.send_request(options)
|
1253
1903
|
end
|
1254
1904
|
|
1255
|
-
# Removes one or more tags from the specified
|
1256
|
-
#
|
1905
|
+
# Removes one or more tags from the specified EventBridge resource. In
|
1906
|
+
# EventBridge, rules can be tagged.
|
1257
1907
|
#
|
1258
1908
|
# @option params [required, String] :resource_arn
|
1259
|
-
# The ARN of the
|
1260
|
-
# tags.
|
1909
|
+
# The ARN of the rule that you're removing tags from.
|
1261
1910
|
#
|
1262
1911
|
# @option params [required, Array<String>] :tag_keys
|
1263
1912
|
# The list of tag keys to remove from the resource.
|
@@ -1293,7 +1942,7 @@ module Aws::CloudWatchEvents
|
|
1293
1942
|
params: params,
|
1294
1943
|
config: config)
|
1295
1944
|
context[:gem_name] = 'aws-sdk-cloudwatchevents'
|
1296
|
-
context[:gem_version] = '1.
|
1945
|
+
context[:gem_version] = '1.23.0'
|
1297
1946
|
Seahorse::Client::Request.new(handlers, context)
|
1298
1947
|
end
|
1299
1948
|
|