aws-sdk-cloudwatchevents 1.37.0 → 1.42.0
Sign up to get free protection for your applications and to get access to all the features.
@@ -28,6 +28,7 @@ module Aws::CloudWatchEvents
|
|
28
28
|
#
|
29
29
|
# ## Error Classes
|
30
30
|
# * {ConcurrentModificationException}
|
31
|
+
# * {IllegalStatusException}
|
31
32
|
# * {InternalException}
|
32
33
|
# * {InvalidEventPatternException}
|
33
34
|
# * {InvalidStateException}
|
@@ -54,6 +55,16 @@ module Aws::CloudWatchEvents
|
|
54
55
|
end
|
55
56
|
end
|
56
57
|
|
58
|
+
class IllegalStatusException < ServiceError
|
59
|
+
|
60
|
+
# @param [Seahorse::Client::RequestContext] context
|
61
|
+
# @param [String] message
|
62
|
+
# @param [Aws::CloudWatchEvents::Types::IllegalStatusException] data
|
63
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
64
|
+
super(context, message, data)
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
57
68
|
class InternalException < ServiceError
|
58
69
|
|
59
70
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -29,6 +29,58 @@ module Aws::CloudWatchEvents
|
|
29
29
|
include Aws::Structure
|
30
30
|
end
|
31
31
|
|
32
|
+
# An `Archive` object that contains details about an archive.
|
33
|
+
#
|
34
|
+
# @!attribute [rw] archive_name
|
35
|
+
# The name of the archive.
|
36
|
+
# @return [String]
|
37
|
+
#
|
38
|
+
# @!attribute [rw] event_source_arn
|
39
|
+
# The ARN of the event bus associated with the archive. Only events
|
40
|
+
# from this event bus are sent to the archive.
|
41
|
+
# @return [String]
|
42
|
+
#
|
43
|
+
# @!attribute [rw] state
|
44
|
+
# The current state of the archive.
|
45
|
+
# @return [String]
|
46
|
+
#
|
47
|
+
# @!attribute [rw] state_reason
|
48
|
+
# A description for the reason that the archive is in the current
|
49
|
+
# state.
|
50
|
+
# @return [String]
|
51
|
+
#
|
52
|
+
# @!attribute [rw] retention_days
|
53
|
+
# The number of days to retain events in the archive before they are
|
54
|
+
# deleted.
|
55
|
+
# @return [Integer]
|
56
|
+
#
|
57
|
+
# @!attribute [rw] size_bytes
|
58
|
+
# The size of the archive, in bytes.
|
59
|
+
# @return [Integer]
|
60
|
+
#
|
61
|
+
# @!attribute [rw] event_count
|
62
|
+
# The number of events in the archive.
|
63
|
+
# @return [Integer]
|
64
|
+
#
|
65
|
+
# @!attribute [rw] creation_time
|
66
|
+
# The time stamp for the time that the archive was created.
|
67
|
+
# @return [Time]
|
68
|
+
#
|
69
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/Archive AWS API Documentation
|
70
|
+
#
|
71
|
+
class Archive < Struct.new(
|
72
|
+
:archive_name,
|
73
|
+
:event_source_arn,
|
74
|
+
:state,
|
75
|
+
:state_reason,
|
76
|
+
:retention_days,
|
77
|
+
:size_bytes,
|
78
|
+
:event_count,
|
79
|
+
:creation_time)
|
80
|
+
SENSITIVE = []
|
81
|
+
include Aws::Structure
|
82
|
+
end
|
83
|
+
|
32
84
|
# This structure specifies the VPC subnets and security groups for the
|
33
85
|
# task, and whether a public IP address is to be used. This structure is
|
34
86
|
# relevant only for ECS tasks that use the `awsvpc` network mode.
|
@@ -171,7 +223,49 @@ module Aws::CloudWatchEvents
|
|
171
223
|
include Aws::Structure
|
172
224
|
end
|
173
225
|
|
174
|
-
#
|
226
|
+
# @note When making an API call, you may pass CancelReplayRequest
|
227
|
+
# data as a hash:
|
228
|
+
#
|
229
|
+
# {
|
230
|
+
# replay_name: "ReplayName", # required
|
231
|
+
# }
|
232
|
+
#
|
233
|
+
# @!attribute [rw] replay_name
|
234
|
+
# The name of the replay to cancel.
|
235
|
+
# @return [String]
|
236
|
+
#
|
237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CancelReplayRequest AWS API Documentation
|
238
|
+
#
|
239
|
+
class CancelReplayRequest < Struct.new(
|
240
|
+
:replay_name)
|
241
|
+
SENSITIVE = []
|
242
|
+
include Aws::Structure
|
243
|
+
end
|
244
|
+
|
245
|
+
# @!attribute [rw] replay_arn
|
246
|
+
# The ARN of the replay to cancel.
|
247
|
+
# @return [String]
|
248
|
+
#
|
249
|
+
# @!attribute [rw] state
|
250
|
+
# The current state of the replay.
|
251
|
+
# @return [String]
|
252
|
+
#
|
253
|
+
# @!attribute [rw] state_reason
|
254
|
+
# The reason that the replay is in the current state.
|
255
|
+
# @return [String]
|
256
|
+
#
|
257
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CancelReplayResponse AWS API Documentation
|
258
|
+
#
|
259
|
+
class CancelReplayResponse < Struct.new(
|
260
|
+
:replay_arn,
|
261
|
+
:state,
|
262
|
+
:state_reason)
|
263
|
+
SENSITIVE = []
|
264
|
+
include Aws::Structure
|
265
|
+
end
|
266
|
+
|
267
|
+
# There is concurrent modification on a rule, target, archive, or
|
268
|
+
# replay.
|
175
269
|
#
|
176
270
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ConcurrentModificationException AWS API Documentation
|
177
271
|
#
|
@@ -221,6 +315,77 @@ module Aws::CloudWatchEvents
|
|
221
315
|
include Aws::Structure
|
222
316
|
end
|
223
317
|
|
318
|
+
# @note When making an API call, you may pass CreateArchiveRequest
|
319
|
+
# data as a hash:
|
320
|
+
#
|
321
|
+
# {
|
322
|
+
# archive_name: "ArchiveName", # required
|
323
|
+
# event_source_arn: "Arn", # required
|
324
|
+
# description: "ArchiveDescription",
|
325
|
+
# event_pattern: "EventPattern",
|
326
|
+
# retention_days: 1,
|
327
|
+
# }
|
328
|
+
#
|
329
|
+
# @!attribute [rw] archive_name
|
330
|
+
# The name for the archive to create.
|
331
|
+
# @return [String]
|
332
|
+
#
|
333
|
+
# @!attribute [rw] event_source_arn
|
334
|
+
# The ARN of the event source associated with the archive.
|
335
|
+
# @return [String]
|
336
|
+
#
|
337
|
+
# @!attribute [rw] description
|
338
|
+
# A description for the archive.
|
339
|
+
# @return [String]
|
340
|
+
#
|
341
|
+
# @!attribute [rw] event_pattern
|
342
|
+
# An event pattern to use to filter events sent to the archive.
|
343
|
+
# @return [String]
|
344
|
+
#
|
345
|
+
# @!attribute [rw] retention_days
|
346
|
+
# The number of days to retain events for. Default value is 0. If set
|
347
|
+
# to 0, events are retained indefinitely
|
348
|
+
# @return [Integer]
|
349
|
+
#
|
350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateArchiveRequest AWS API Documentation
|
351
|
+
#
|
352
|
+
class CreateArchiveRequest < Struct.new(
|
353
|
+
:archive_name,
|
354
|
+
:event_source_arn,
|
355
|
+
:description,
|
356
|
+
:event_pattern,
|
357
|
+
:retention_days)
|
358
|
+
SENSITIVE = []
|
359
|
+
include Aws::Structure
|
360
|
+
end
|
361
|
+
|
362
|
+
# @!attribute [rw] archive_arn
|
363
|
+
# The ARN of the archive that was created.
|
364
|
+
# @return [String]
|
365
|
+
#
|
366
|
+
# @!attribute [rw] state
|
367
|
+
# The state of the archive that was created.
|
368
|
+
# @return [String]
|
369
|
+
#
|
370
|
+
# @!attribute [rw] state_reason
|
371
|
+
# The reason that the archive is in the state.
|
372
|
+
# @return [String]
|
373
|
+
#
|
374
|
+
# @!attribute [rw] creation_time
|
375
|
+
# The time at which the archive was created.
|
376
|
+
# @return [Time]
|
377
|
+
#
|
378
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateArchiveResponse AWS API Documentation
|
379
|
+
#
|
380
|
+
class CreateArchiveResponse < Struct.new(
|
381
|
+
:archive_arn,
|
382
|
+
:state,
|
383
|
+
:state_reason,
|
384
|
+
:creation_time)
|
385
|
+
SENSITIVE = []
|
386
|
+
include Aws::Structure
|
387
|
+
end
|
388
|
+
|
224
389
|
# @note When making an API call, you may pass CreateEventBusRequest
|
225
390
|
# data as a hash:
|
226
391
|
#
|
@@ -338,6 +503,52 @@ module Aws::CloudWatchEvents
|
|
338
503
|
include Aws::Structure
|
339
504
|
end
|
340
505
|
|
506
|
+
# A `DeadLetterConfig` object that contains information about a
|
507
|
+
# dead-letter queue configuration.
|
508
|
+
#
|
509
|
+
# @note When making an API call, you may pass DeadLetterConfig
|
510
|
+
# data as a hash:
|
511
|
+
#
|
512
|
+
# {
|
513
|
+
# arn: "ResourceArn",
|
514
|
+
# }
|
515
|
+
#
|
516
|
+
# @!attribute [rw] arn
|
517
|
+
# The ARN of the SQS queue specified as the target for the dead-letter
|
518
|
+
# queue.
|
519
|
+
# @return [String]
|
520
|
+
#
|
521
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeadLetterConfig AWS API Documentation
|
522
|
+
#
|
523
|
+
class DeadLetterConfig < Struct.new(
|
524
|
+
:arn)
|
525
|
+
SENSITIVE = []
|
526
|
+
include Aws::Structure
|
527
|
+
end
|
528
|
+
|
529
|
+
# @note When making an API call, you may pass DeleteArchiveRequest
|
530
|
+
# data as a hash:
|
531
|
+
#
|
532
|
+
# {
|
533
|
+
# archive_name: "ArchiveName", # required
|
534
|
+
# }
|
535
|
+
#
|
536
|
+
# @!attribute [rw] archive_name
|
537
|
+
# The name of the archive to delete.
|
538
|
+
# @return [String]
|
539
|
+
#
|
540
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteArchiveRequest AWS API Documentation
|
541
|
+
#
|
542
|
+
class DeleteArchiveRequest < Struct.new(
|
543
|
+
:archive_name)
|
544
|
+
SENSITIVE = []
|
545
|
+
include Aws::Structure
|
546
|
+
end
|
547
|
+
|
548
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteArchiveResponse AWS API Documentation
|
549
|
+
#
|
550
|
+
class DeleteArchiveResponse < Aws::EmptyStructure; end
|
551
|
+
|
341
552
|
# @note When making an API call, you may pass DeleteEventBusRequest
|
342
553
|
# data as a hash:
|
343
554
|
#
|
@@ -388,7 +599,7 @@ module Aws::CloudWatchEvents
|
|
388
599
|
#
|
389
600
|
# {
|
390
601
|
# name: "RuleName", # required
|
391
|
-
# event_bus_name: "
|
602
|
+
# event_bus_name: "EventBusNameOrArn",
|
392
603
|
# force: false,
|
393
604
|
# }
|
394
605
|
#
|
@@ -397,8 +608,8 @@ module Aws::CloudWatchEvents
|
|
397
608
|
# @return [String]
|
398
609
|
#
|
399
610
|
# @!attribute [rw] event_bus_name
|
400
|
-
# The event bus associated with the rule. If you
|
401
|
-
# default event bus is used.
|
611
|
+
# The name or ARN of the event bus associated with the rule. If you
|
612
|
+
# omit this, the default event bus is used.
|
402
613
|
# @return [String]
|
403
614
|
#
|
404
615
|
# @!attribute [rw] force
|
@@ -419,16 +630,97 @@ module Aws::CloudWatchEvents
|
|
419
630
|
include Aws::Structure
|
420
631
|
end
|
421
632
|
|
633
|
+
# @note When making an API call, you may pass DescribeArchiveRequest
|
634
|
+
# data as a hash:
|
635
|
+
#
|
636
|
+
# {
|
637
|
+
# archive_name: "ArchiveName", # required
|
638
|
+
# }
|
639
|
+
#
|
640
|
+
# @!attribute [rw] archive_name
|
641
|
+
# The name of the archive to retrieve.
|
642
|
+
# @return [String]
|
643
|
+
#
|
644
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeArchiveRequest AWS API Documentation
|
645
|
+
#
|
646
|
+
class DescribeArchiveRequest < Struct.new(
|
647
|
+
:archive_name)
|
648
|
+
SENSITIVE = []
|
649
|
+
include Aws::Structure
|
650
|
+
end
|
651
|
+
|
652
|
+
# @!attribute [rw] archive_arn
|
653
|
+
# The ARN of the archive.
|
654
|
+
# @return [String]
|
655
|
+
#
|
656
|
+
# @!attribute [rw] archive_name
|
657
|
+
# The name of the archive.
|
658
|
+
# @return [String]
|
659
|
+
#
|
660
|
+
# @!attribute [rw] event_source_arn
|
661
|
+
# The ARN of the event source associated with the archive.
|
662
|
+
# @return [String]
|
663
|
+
#
|
664
|
+
# @!attribute [rw] description
|
665
|
+
# The description of the archive.
|
666
|
+
# @return [String]
|
667
|
+
#
|
668
|
+
# @!attribute [rw] event_pattern
|
669
|
+
# The event pattern used to filter events sent to the archive.
|
670
|
+
# @return [String]
|
671
|
+
#
|
672
|
+
# @!attribute [rw] state
|
673
|
+
# The state of the archive.
|
674
|
+
# @return [String]
|
675
|
+
#
|
676
|
+
# @!attribute [rw] state_reason
|
677
|
+
# The reason that the archive is in the state.
|
678
|
+
# @return [String]
|
679
|
+
#
|
680
|
+
# @!attribute [rw] retention_days
|
681
|
+
# The number of days to retain events for in the archive.
|
682
|
+
# @return [Integer]
|
683
|
+
#
|
684
|
+
# @!attribute [rw] size_bytes
|
685
|
+
# The size of the archive in bytes.
|
686
|
+
# @return [Integer]
|
687
|
+
#
|
688
|
+
# @!attribute [rw] event_count
|
689
|
+
# The number of events in the archive.
|
690
|
+
# @return [Integer]
|
691
|
+
#
|
692
|
+
# @!attribute [rw] creation_time
|
693
|
+
# The time at which the archive was created.
|
694
|
+
# @return [Time]
|
695
|
+
#
|
696
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeArchiveResponse AWS API Documentation
|
697
|
+
#
|
698
|
+
class DescribeArchiveResponse < Struct.new(
|
699
|
+
:archive_arn,
|
700
|
+
:archive_name,
|
701
|
+
:event_source_arn,
|
702
|
+
:description,
|
703
|
+
:event_pattern,
|
704
|
+
:state,
|
705
|
+
:state_reason,
|
706
|
+
:retention_days,
|
707
|
+
:size_bytes,
|
708
|
+
:event_count,
|
709
|
+
:creation_time)
|
710
|
+
SENSITIVE = []
|
711
|
+
include Aws::Structure
|
712
|
+
end
|
713
|
+
|
422
714
|
# @note When making an API call, you may pass DescribeEventBusRequest
|
423
715
|
# data as a hash:
|
424
716
|
#
|
425
717
|
# {
|
426
|
-
# name: "
|
718
|
+
# name: "EventBusNameOrArn",
|
427
719
|
# }
|
428
720
|
#
|
429
721
|
# @!attribute [rw] name
|
430
|
-
# The name of the event bus to show details for. If you omit
|
431
|
-
# default event bus is displayed.
|
722
|
+
# The name or ARN of the event bus to show details for. If you omit
|
723
|
+
# this, the default event bus is displayed.
|
432
724
|
# @return [String]
|
433
725
|
#
|
434
726
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeEventBusRequest AWS API Documentation
|
@@ -561,12 +853,100 @@ module Aws::CloudWatchEvents
|
|
561
853
|
include Aws::Structure
|
562
854
|
end
|
563
855
|
|
856
|
+
# @note When making an API call, you may pass DescribeReplayRequest
|
857
|
+
# data as a hash:
|
858
|
+
#
|
859
|
+
# {
|
860
|
+
# replay_name: "ReplayName", # required
|
861
|
+
# }
|
862
|
+
#
|
863
|
+
# @!attribute [rw] replay_name
|
864
|
+
# The name of the replay to retrieve.
|
865
|
+
# @return [String]
|
866
|
+
#
|
867
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeReplayRequest AWS API Documentation
|
868
|
+
#
|
869
|
+
class DescribeReplayRequest < Struct.new(
|
870
|
+
:replay_name)
|
871
|
+
SENSITIVE = []
|
872
|
+
include Aws::Structure
|
873
|
+
end
|
874
|
+
|
875
|
+
# @!attribute [rw] replay_name
|
876
|
+
# The name of the replay.
|
877
|
+
# @return [String]
|
878
|
+
#
|
879
|
+
# @!attribute [rw] replay_arn
|
880
|
+
# The ARN of the replay.
|
881
|
+
# @return [String]
|
882
|
+
#
|
883
|
+
# @!attribute [rw] description
|
884
|
+
# The description of the replay.
|
885
|
+
# @return [String]
|
886
|
+
#
|
887
|
+
# @!attribute [rw] state
|
888
|
+
# The current state of the replay.
|
889
|
+
# @return [String]
|
890
|
+
#
|
891
|
+
# @!attribute [rw] state_reason
|
892
|
+
# The reason that the replay is in the current state.
|
893
|
+
# @return [String]
|
894
|
+
#
|
895
|
+
# @!attribute [rw] event_source_arn
|
896
|
+
# The ARN of the archive events were replayed from.
|
897
|
+
# @return [String]
|
898
|
+
#
|
899
|
+
# @!attribute [rw] destination
|
900
|
+
# A `ReplayDestination` object that contains details about the replay.
|
901
|
+
# @return [Types::ReplayDestination]
|
902
|
+
#
|
903
|
+
# @!attribute [rw] event_start_time
|
904
|
+
# The time stamp of the first event that was last replayed from the
|
905
|
+
# archive.
|
906
|
+
# @return [Time]
|
907
|
+
#
|
908
|
+
# @!attribute [rw] event_end_time
|
909
|
+
# The time stamp for the last event that was replayed from the
|
910
|
+
# archive.
|
911
|
+
# @return [Time]
|
912
|
+
#
|
913
|
+
# @!attribute [rw] event_last_replayed_time
|
914
|
+
# The time that the event was last replayed.
|
915
|
+
# @return [Time]
|
916
|
+
#
|
917
|
+
# @!attribute [rw] replay_start_time
|
918
|
+
# A time stamp for the time that the replay started.
|
919
|
+
# @return [Time]
|
920
|
+
#
|
921
|
+
# @!attribute [rw] replay_end_time
|
922
|
+
# A time stamp for the time that the replay stopped.
|
923
|
+
# @return [Time]
|
924
|
+
#
|
925
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeReplayResponse AWS API Documentation
|
926
|
+
#
|
927
|
+
class DescribeReplayResponse < Struct.new(
|
928
|
+
:replay_name,
|
929
|
+
:replay_arn,
|
930
|
+
:description,
|
931
|
+
:state,
|
932
|
+
:state_reason,
|
933
|
+
:event_source_arn,
|
934
|
+
:destination,
|
935
|
+
:event_start_time,
|
936
|
+
:event_end_time,
|
937
|
+
:event_last_replayed_time,
|
938
|
+
:replay_start_time,
|
939
|
+
:replay_end_time)
|
940
|
+
SENSITIVE = []
|
941
|
+
include Aws::Structure
|
942
|
+
end
|
943
|
+
|
564
944
|
# @note When making an API call, you may pass DescribeRuleRequest
|
565
945
|
# data as a hash:
|
566
946
|
#
|
567
947
|
# {
|
568
948
|
# name: "RuleName", # required
|
569
|
-
# event_bus_name: "
|
949
|
+
# event_bus_name: "EventBusNameOrArn",
|
570
950
|
# }
|
571
951
|
#
|
572
952
|
# @!attribute [rw] name
|
@@ -574,8 +954,8 @@ module Aws::CloudWatchEvents
|
|
574
954
|
# @return [String]
|
575
955
|
#
|
576
956
|
# @!attribute [rw] event_bus_name
|
577
|
-
# The event bus associated with the rule. If you
|
578
|
-
# default event bus is used.
|
957
|
+
# The name or ARN of the event bus associated with the rule. If you
|
958
|
+
# omit this, the default event bus is used.
|
579
959
|
# @return [String]
|
580
960
|
#
|
581
961
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeRuleRequest AWS API Documentation
|
@@ -629,7 +1009,16 @@ module Aws::CloudWatchEvents
|
|
629
1009
|
# @return [String]
|
630
1010
|
#
|
631
1011
|
# @!attribute [rw] event_bus_name
|
632
|
-
# The event bus associated with the rule.
|
1012
|
+
# The name of the event bus associated with the rule.
|
1013
|
+
# @return [String]
|
1014
|
+
#
|
1015
|
+
# @!attribute [rw] created_by
|
1016
|
+
# The account ID of the user that created the rule. If you use
|
1017
|
+
# `PutRule` to put a rule on an event bus in another account, the
|
1018
|
+
# other account is the owner of the rule, and the rule ARN includes
|
1019
|
+
# the account ID for that account. However, the value for `CreatedBy`
|
1020
|
+
# is the account ID as the account that created the rule in the other
|
1021
|
+
# account.
|
633
1022
|
# @return [String]
|
634
1023
|
#
|
635
1024
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeRuleResponse AWS API Documentation
|
@@ -643,7 +1032,8 @@ module Aws::CloudWatchEvents
|
|
643
1032
|
:description,
|
644
1033
|
:role_arn,
|
645
1034
|
:managed_by,
|
646
|
-
:event_bus_name
|
1035
|
+
:event_bus_name,
|
1036
|
+
:created_by)
|
647
1037
|
SENSITIVE = []
|
648
1038
|
include Aws::Structure
|
649
1039
|
end
|
@@ -653,7 +1043,7 @@ module Aws::CloudWatchEvents
|
|
653
1043
|
#
|
654
1044
|
# {
|
655
1045
|
# name: "RuleName", # required
|
656
|
-
# event_bus_name: "
|
1046
|
+
# event_bus_name: "EventBusNameOrArn",
|
657
1047
|
# }
|
658
1048
|
#
|
659
1049
|
# @!attribute [rw] name
|
@@ -661,8 +1051,8 @@ module Aws::CloudWatchEvents
|
|
661
1051
|
# @return [String]
|
662
1052
|
#
|
663
1053
|
# @!attribute [rw] event_bus_name
|
664
|
-
# The event bus associated with the rule. If you
|
665
|
-
# default event bus is used.
|
1054
|
+
# The name or ARN of the event bus associated with the rule. If you
|
1055
|
+
# omit this, the default event bus is used.
|
666
1056
|
# @return [String]
|
667
1057
|
#
|
668
1058
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DisableRuleRequest AWS API Documentation
|
@@ -766,7 +1156,7 @@ module Aws::CloudWatchEvents
|
|
766
1156
|
#
|
767
1157
|
# {
|
768
1158
|
# name: "RuleName", # required
|
769
|
-
# event_bus_name: "
|
1159
|
+
# event_bus_name: "EventBusNameOrArn",
|
770
1160
|
# }
|
771
1161
|
#
|
772
1162
|
# @!attribute [rw] name
|
@@ -774,8 +1164,8 @@ module Aws::CloudWatchEvents
|
|
774
1164
|
# @return [String]
|
775
1165
|
#
|
776
1166
|
# @!attribute [rw] event_bus_name
|
777
|
-
# The event bus associated with the rule. If you
|
778
|
-
# default event bus is used.
|
1167
|
+
# The name or ARN of the event bus associated with the rule. If you
|
1168
|
+
# omit this, the default event bus is used.
|
779
1169
|
# @return [String]
|
780
1170
|
#
|
781
1171
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/EnableRuleRequest AWS API Documentation
|
@@ -907,6 +1297,13 @@ module Aws::CloudWatchEvents
|
|
907
1297
|
include Aws::Structure
|
908
1298
|
end
|
909
1299
|
|
1300
|
+
# An error occurred because a replay can be canceled only when the state
|
1301
|
+
# is Running or Starting.
|
1302
|
+
#
|
1303
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/IllegalStatusException AWS API Documentation
|
1304
|
+
#
|
1305
|
+
class IllegalStatusException < Aws::EmptyStructure; end
|
1306
|
+
|
910
1307
|
# Contains the parameters needed for you to provide custom input to a
|
911
1308
|
# target based on one or more pieces of data extracted from the event.
|
912
1309
|
#
|
@@ -1033,13 +1430,76 @@ module Aws::CloudWatchEvents
|
|
1033
1430
|
include Aws::Structure
|
1034
1431
|
end
|
1035
1432
|
|
1036
|
-
#
|
1037
|
-
# allowed.
|
1433
|
+
# The request failed because it attempted to create resource beyond the
|
1434
|
+
# allowed service quota.
|
1038
1435
|
#
|
1039
1436
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/LimitExceededException AWS API Documentation
|
1040
1437
|
#
|
1041
1438
|
class LimitExceededException < Aws::EmptyStructure; end
|
1042
1439
|
|
1440
|
+
# @note When making an API call, you may pass ListArchivesRequest
|
1441
|
+
# data as a hash:
|
1442
|
+
#
|
1443
|
+
# {
|
1444
|
+
# name_prefix: "ArchiveName",
|
1445
|
+
# event_source_arn: "Arn",
|
1446
|
+
# state: "ENABLED", # accepts ENABLED, DISABLED, CREATING, UPDATING, CREATE_FAILED, UPDATE_FAILED
|
1447
|
+
# next_token: "NextToken",
|
1448
|
+
# limit: 1,
|
1449
|
+
# }
|
1450
|
+
#
|
1451
|
+
# @!attribute [rw] name_prefix
|
1452
|
+
# A name prefix to filter the archives returned. Only archives with
|
1453
|
+
# name that match the prefix are returned.
|
1454
|
+
# @return [String]
|
1455
|
+
#
|
1456
|
+
# @!attribute [rw] event_source_arn
|
1457
|
+
# The ARN of the event source associated with the archive.
|
1458
|
+
# @return [String]
|
1459
|
+
#
|
1460
|
+
# @!attribute [rw] state
|
1461
|
+
# The state of the archive.
|
1462
|
+
# @return [String]
|
1463
|
+
#
|
1464
|
+
# @!attribute [rw] next_token
|
1465
|
+
# The token returned by a previous call to retrieve the next set of
|
1466
|
+
# results.
|
1467
|
+
# @return [String]
|
1468
|
+
#
|
1469
|
+
# @!attribute [rw] limit
|
1470
|
+
# The maximum number of results to return.
|
1471
|
+
# @return [Integer]
|
1472
|
+
#
|
1473
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListArchivesRequest AWS API Documentation
|
1474
|
+
#
|
1475
|
+
class ListArchivesRequest < Struct.new(
|
1476
|
+
:name_prefix,
|
1477
|
+
:event_source_arn,
|
1478
|
+
:state,
|
1479
|
+
:next_token,
|
1480
|
+
:limit)
|
1481
|
+
SENSITIVE = []
|
1482
|
+
include Aws::Structure
|
1483
|
+
end
|
1484
|
+
|
1485
|
+
# @!attribute [rw] archives
|
1486
|
+
# An array of `Archive` objects that include details about an archive.
|
1487
|
+
# @return [Array<Types::Archive>]
|
1488
|
+
#
|
1489
|
+
# @!attribute [rw] next_token
|
1490
|
+
# The token returned by a previous call to retrieve the next set of
|
1491
|
+
# results.
|
1492
|
+
# @return [String]
|
1493
|
+
#
|
1494
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListArchivesResponse AWS API Documentation
|
1495
|
+
#
|
1496
|
+
class ListArchivesResponse < Struct.new(
|
1497
|
+
:archives,
|
1498
|
+
:next_token)
|
1499
|
+
SENSITIVE = []
|
1500
|
+
include Aws::Structure
|
1501
|
+
end
|
1502
|
+
|
1043
1503
|
# @note When making an API call, you may pass ListEventBusesRequest
|
1044
1504
|
# data as a hash:
|
1045
1505
|
#
|
@@ -1252,12 +1712,76 @@ module Aws::CloudWatchEvents
|
|
1252
1712
|
include Aws::Structure
|
1253
1713
|
end
|
1254
1714
|
|
1715
|
+
# @note When making an API call, you may pass ListReplaysRequest
|
1716
|
+
# data as a hash:
|
1717
|
+
#
|
1718
|
+
# {
|
1719
|
+
# name_prefix: "ReplayName",
|
1720
|
+
# state: "STARTING", # accepts STARTING, RUNNING, CANCELLING, COMPLETED, CANCELLED, FAILED
|
1721
|
+
# event_source_arn: "Arn",
|
1722
|
+
# next_token: "NextToken",
|
1723
|
+
# limit: 1,
|
1724
|
+
# }
|
1725
|
+
#
|
1726
|
+
# @!attribute [rw] name_prefix
|
1727
|
+
# A name prefix to filter the replays returned. Only replays with name
|
1728
|
+
# that match the prefix are returned.
|
1729
|
+
# @return [String]
|
1730
|
+
#
|
1731
|
+
# @!attribute [rw] state
|
1732
|
+
# The state of the replay.
|
1733
|
+
# @return [String]
|
1734
|
+
#
|
1735
|
+
# @!attribute [rw] event_source_arn
|
1736
|
+
# The ARN of the event source associated with the replay.
|
1737
|
+
# @return [String]
|
1738
|
+
#
|
1739
|
+
# @!attribute [rw] next_token
|
1740
|
+
# The token returned by a previous call to retrieve the next set of
|
1741
|
+
# results.
|
1742
|
+
# @return [String]
|
1743
|
+
#
|
1744
|
+
# @!attribute [rw] limit
|
1745
|
+
# The maximum number of replays to retrieve.
|
1746
|
+
# @return [Integer]
|
1747
|
+
#
|
1748
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListReplaysRequest AWS API Documentation
|
1749
|
+
#
|
1750
|
+
class ListReplaysRequest < Struct.new(
|
1751
|
+
:name_prefix,
|
1752
|
+
:state,
|
1753
|
+
:event_source_arn,
|
1754
|
+
:next_token,
|
1755
|
+
:limit)
|
1756
|
+
SENSITIVE = []
|
1757
|
+
include Aws::Structure
|
1758
|
+
end
|
1759
|
+
|
1760
|
+
# @!attribute [rw] replays
|
1761
|
+
# An array of `Replay` objects that contain information about the
|
1762
|
+
# replay.
|
1763
|
+
# @return [Array<Types::Replay>]
|
1764
|
+
#
|
1765
|
+
# @!attribute [rw] next_token
|
1766
|
+
# The token returned by a previous call to retrieve the next set of
|
1767
|
+
# results.
|
1768
|
+
# @return [String]
|
1769
|
+
#
|
1770
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListReplaysResponse AWS API Documentation
|
1771
|
+
#
|
1772
|
+
class ListReplaysResponse < Struct.new(
|
1773
|
+
:replays,
|
1774
|
+
:next_token)
|
1775
|
+
SENSITIVE = []
|
1776
|
+
include Aws::Structure
|
1777
|
+
end
|
1778
|
+
|
1255
1779
|
# @note When making an API call, you may pass ListRuleNamesByTargetRequest
|
1256
1780
|
# data as a hash:
|
1257
1781
|
#
|
1258
1782
|
# {
|
1259
1783
|
# target_arn: "TargetArn", # required
|
1260
|
-
# event_bus_name: "
|
1784
|
+
# event_bus_name: "EventBusNameOrArn",
|
1261
1785
|
# next_token: "NextToken",
|
1262
1786
|
# limit: 1,
|
1263
1787
|
# }
|
@@ -1267,8 +1791,8 @@ module Aws::CloudWatchEvents
|
|
1267
1791
|
# @return [String]
|
1268
1792
|
#
|
1269
1793
|
# @!attribute [rw] event_bus_name
|
1270
|
-
#
|
1271
|
-
#
|
1794
|
+
# The name or ARN of the event bus to list rules for. If you omit
|
1795
|
+
# this, the default event bus is used.
|
1272
1796
|
# @return [String]
|
1273
1797
|
#
|
1274
1798
|
# @!attribute [rw] next_token
|
@@ -1314,7 +1838,7 @@ module Aws::CloudWatchEvents
|
|
1314
1838
|
#
|
1315
1839
|
# {
|
1316
1840
|
# name_prefix: "RuleName",
|
1317
|
-
# event_bus_name: "
|
1841
|
+
# event_bus_name: "EventBusNameOrArn",
|
1318
1842
|
# next_token: "NextToken",
|
1319
1843
|
# limit: 1,
|
1320
1844
|
# }
|
@@ -1324,8 +1848,8 @@ module Aws::CloudWatchEvents
|
|
1324
1848
|
# @return [String]
|
1325
1849
|
#
|
1326
1850
|
# @!attribute [rw] event_bus_name
|
1327
|
-
#
|
1328
|
-
#
|
1851
|
+
# The name or ARN of the event bus to list the rules for. If you omit
|
1852
|
+
# this, the default event bus is used.
|
1329
1853
|
# @return [String]
|
1330
1854
|
#
|
1331
1855
|
# @!attribute [rw] next_token
|
@@ -1403,7 +1927,7 @@ module Aws::CloudWatchEvents
|
|
1403
1927
|
#
|
1404
1928
|
# {
|
1405
1929
|
# rule: "RuleName", # required
|
1406
|
-
# event_bus_name: "
|
1930
|
+
# event_bus_name: "EventBusNameOrArn",
|
1407
1931
|
# next_token: "NextToken",
|
1408
1932
|
# limit: 1,
|
1409
1933
|
# }
|
@@ -1413,8 +1937,8 @@ module Aws::CloudWatchEvents
|
|
1413
1937
|
# @return [String]
|
1414
1938
|
#
|
1415
1939
|
# @!attribute [rw] event_bus_name
|
1416
|
-
# The event bus associated with the rule. If you
|
1417
|
-
# default event bus is used.
|
1940
|
+
# The name or ARN of the event bus associated with the rule. If you
|
1941
|
+
# omit this, the default event bus is used.
|
1418
1942
|
# @return [String]
|
1419
1943
|
#
|
1420
1944
|
# @!attribute [rw] next_token
|
@@ -1576,7 +2100,8 @@ module Aws::CloudWatchEvents
|
|
1576
2100
|
# resources: ["EventResource"],
|
1577
2101
|
# detail_type: "String",
|
1578
2102
|
# detail: "String",
|
1579
|
-
# event_bus_name: "
|
2103
|
+
# event_bus_name: "NonPartnerEventBusNameOrArn",
|
2104
|
+
# trace_header: "TraceHeader",
|
1580
2105
|
# },
|
1581
2106
|
# ],
|
1582
2107
|
# }
|
@@ -1606,7 +2131,8 @@ module Aws::CloudWatchEvents
|
|
1606
2131
|
# resources: ["EventResource"],
|
1607
2132
|
# detail_type: "String",
|
1608
2133
|
# detail: "String",
|
1609
|
-
# event_bus_name: "
|
2134
|
+
# event_bus_name: "NonPartnerEventBusNameOrArn",
|
2135
|
+
# trace_header: "TraceHeader",
|
1610
2136
|
# }
|
1611
2137
|
#
|
1612
2138
|
# @!attribute [rw] time
|
@@ -1639,8 +2165,21 @@ module Aws::CloudWatchEvents
|
|
1639
2165
|
# @return [String]
|
1640
2166
|
#
|
1641
2167
|
# @!attribute [rw] event_bus_name
|
1642
|
-
# The event bus
|
1643
|
-
# associated with this event bus
|
2168
|
+
# The name or ARN of the event bus to receive the event. Only the
|
2169
|
+
# rules that are associated with this event bus are used to match the
|
2170
|
+
# event. If you omit this, the default event bus is used.
|
2171
|
+
# @return [String]
|
2172
|
+
#
|
2173
|
+
# @!attribute [rw] trace_header
|
2174
|
+
# An AWS X-Ray trade header, which is an http header (X-Amzn-Trace-Id)
|
2175
|
+
# that contains the trace-id associated with the event.
|
2176
|
+
#
|
2177
|
+
# To learn more about X-Ray trace headers, see [Tracing header][1] in
|
2178
|
+
# the AWS X-Ray Developer Guide.
|
2179
|
+
#
|
2180
|
+
#
|
2181
|
+
#
|
2182
|
+
# [1]: https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader
|
1644
2183
|
# @return [String]
|
1645
2184
|
#
|
1646
2185
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutEventsRequestEntry AWS API Documentation
|
@@ -1651,7 +2190,8 @@ module Aws::CloudWatchEvents
|
|
1651
2190
|
:resources,
|
1652
2191
|
:detail_type,
|
1653
2192
|
:detail,
|
1654
|
-
:event_bus_name
|
2193
|
+
:event_bus_name,
|
2194
|
+
:trace_header)
|
1655
2195
|
SENSITIVE = []
|
1656
2196
|
include Aws::Structure
|
1657
2197
|
end
|
@@ -1824,19 +2364,20 @@ module Aws::CloudWatchEvents
|
|
1824
2364
|
#
|
1825
2365
|
# {
|
1826
2366
|
# event_bus_name: "NonPartnerEventBusName",
|
1827
|
-
# action: "Action",
|
1828
|
-
# principal: "Principal",
|
1829
|
-
# statement_id: "StatementId",
|
2367
|
+
# action: "Action",
|
2368
|
+
# principal: "Principal",
|
2369
|
+
# statement_id: "StatementId",
|
1830
2370
|
# condition: {
|
1831
2371
|
# type: "String", # required
|
1832
2372
|
# key: "String", # required
|
1833
2373
|
# value: "String", # required
|
1834
2374
|
# },
|
2375
|
+
# policy: "String",
|
1835
2376
|
# }
|
1836
2377
|
#
|
1837
2378
|
# @!attribute [rw] event_bus_name
|
1838
|
-
# The event bus associated with the rule. If you omit
|
1839
|
-
# default event bus is used.
|
2379
|
+
# The name of the event bus associated with the rule. If you omit
|
2380
|
+
# this, the default event bus is used.
|
1840
2381
|
# @return [String]
|
1841
2382
|
#
|
1842
2383
|
# @!attribute [rw] action
|
@@ -1883,6 +2424,12 @@ module Aws::CloudWatchEvents
|
|
1883
2424
|
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html
|
1884
2425
|
# @return [Types::Condition]
|
1885
2426
|
#
|
2427
|
+
# @!attribute [rw] policy
|
2428
|
+
# A JSON string that describes the permission policy statement. You
|
2429
|
+
# can include a `Policy` parameter in the request instead of using the
|
2430
|
+
# `StatementId`, `Action`, `Principal`, or `Condition` parameters.
|
2431
|
+
# @return [String]
|
2432
|
+
#
|
1886
2433
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutPermissionRequest AWS API Documentation
|
1887
2434
|
#
|
1888
2435
|
class PutPermissionRequest < Struct.new(
|
@@ -1890,7 +2437,8 @@ module Aws::CloudWatchEvents
|
|
1890
2437
|
:action,
|
1891
2438
|
:principal,
|
1892
2439
|
:statement_id,
|
1893
|
-
:condition
|
2440
|
+
:condition,
|
2441
|
+
:policy)
|
1894
2442
|
SENSITIVE = []
|
1895
2443
|
include Aws::Structure
|
1896
2444
|
end
|
@@ -1911,7 +2459,7 @@ module Aws::CloudWatchEvents
|
|
1911
2459
|
# value: "TagValue", # required
|
1912
2460
|
# },
|
1913
2461
|
# ],
|
1914
|
-
# event_bus_name: "
|
2462
|
+
# event_bus_name: "EventBusNameOrArn",
|
1915
2463
|
# }
|
1916
2464
|
#
|
1917
2465
|
# @!attribute [rw] name
|
@@ -1950,8 +2498,8 @@ module Aws::CloudWatchEvents
|
|
1950
2498
|
# @return [Array<Types::Tag>]
|
1951
2499
|
#
|
1952
2500
|
# @!attribute [rw] event_bus_name
|
1953
|
-
# The event bus to associate with this rule. If you
|
1954
|
-
# default event bus is used.
|
2501
|
+
# The name or ARN of the event bus to associate with this rule. If you
|
2502
|
+
# omit this, the default event bus is used.
|
1955
2503
|
# @return [String]
|
1956
2504
|
#
|
1957
2505
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutRuleRequest AWS API Documentation
|
@@ -1986,7 +2534,7 @@ module Aws::CloudWatchEvents
|
|
1986
2534
|
#
|
1987
2535
|
# {
|
1988
2536
|
# rule: "RuleName", # required
|
1989
|
-
# event_bus_name: "
|
2537
|
+
# event_bus_name: "EventBusNameOrArn",
|
1990
2538
|
# targets: [ # required
|
1991
2539
|
# {
|
1992
2540
|
# id: "TargetId", # required
|
@@ -2055,6 +2603,13 @@ module Aws::CloudWatchEvents
|
|
2055
2603
|
# statement_name: "StatementName",
|
2056
2604
|
# with_event: false,
|
2057
2605
|
# },
|
2606
|
+
# dead_letter_config: {
|
2607
|
+
# arn: "ResourceArn",
|
2608
|
+
# },
|
2609
|
+
# retry_policy: {
|
2610
|
+
# maximum_retry_attempts: 1,
|
2611
|
+
# maximum_event_age_in_seconds: 1,
|
2612
|
+
# },
|
2058
2613
|
# },
|
2059
2614
|
# ],
|
2060
2615
|
# }
|
@@ -2064,8 +2619,8 @@ module Aws::CloudWatchEvents
|
|
2064
2619
|
# @return [String]
|
2065
2620
|
#
|
2066
2621
|
# @!attribute [rw] event_bus_name
|
2067
|
-
# The name of the event bus associated with the rule. If you
|
2068
|
-
# this, the default event bus is used.
|
2622
|
+
# The name or ARN of the event bus associated with the rule. If you
|
2623
|
+
# omit this, the default event bus is used.
|
2069
2624
|
# @return [String]
|
2070
2625
|
#
|
2071
2626
|
# @!attribute [rw] targets
|
@@ -2187,7 +2742,8 @@ module Aws::CloudWatchEvents
|
|
2187
2742
|
# data as a hash:
|
2188
2743
|
#
|
2189
2744
|
# {
|
2190
|
-
# statement_id: "StatementId",
|
2745
|
+
# statement_id: "StatementId",
|
2746
|
+
# remove_all_permissions: false,
|
2191
2747
|
# event_bus_name: "NonPartnerEventBusName",
|
2192
2748
|
# }
|
2193
2749
|
#
|
@@ -2196,6 +2752,10 @@ module Aws::CloudWatchEvents
|
|
2196
2752
|
# allowed to put events to the default event bus.
|
2197
2753
|
# @return [String]
|
2198
2754
|
#
|
2755
|
+
# @!attribute [rw] remove_all_permissions
|
2756
|
+
# Specifies whether to remove all permissions.
|
2757
|
+
# @return [Boolean]
|
2758
|
+
#
|
2199
2759
|
# @!attribute [rw] event_bus_name
|
2200
2760
|
# The name of the event bus to revoke permissions for. If you omit
|
2201
2761
|
# this, the default event bus is used.
|
@@ -2205,6 +2765,7 @@ module Aws::CloudWatchEvents
|
|
2205
2765
|
#
|
2206
2766
|
class RemovePermissionRequest < Struct.new(
|
2207
2767
|
:statement_id,
|
2768
|
+
:remove_all_permissions,
|
2208
2769
|
:event_bus_name)
|
2209
2770
|
SENSITIVE = []
|
2210
2771
|
include Aws::Structure
|
@@ -2215,7 +2776,7 @@ module Aws::CloudWatchEvents
|
|
2215
2776
|
#
|
2216
2777
|
# {
|
2217
2778
|
# rule: "RuleName", # required
|
2218
|
-
# event_bus_name: "
|
2779
|
+
# event_bus_name: "EventBusNameOrArn",
|
2219
2780
|
# ids: ["TargetId"], # required
|
2220
2781
|
# force: false,
|
2221
2782
|
# }
|
@@ -2225,7 +2786,8 @@ module Aws::CloudWatchEvents
|
|
2225
2786
|
# @return [String]
|
2226
2787
|
#
|
2227
2788
|
# @!attribute [rw] event_bus_name
|
2228
|
-
# The name of the event bus associated with the rule.
|
2789
|
+
# The name or ARN of the event bus associated with the rule. If you
|
2790
|
+
# omit this, the default event bus is used.
|
2229
2791
|
# @return [String]
|
2230
2792
|
#
|
2231
2793
|
# @!attribute [rw] ids
|
@@ -2294,6 +2856,94 @@ module Aws::CloudWatchEvents
|
|
2294
2856
|
include Aws::Structure
|
2295
2857
|
end
|
2296
2858
|
|
2859
|
+
# A `Replay` object that contains details about a replay.
|
2860
|
+
#
|
2861
|
+
# @!attribute [rw] replay_name
|
2862
|
+
# The name of the replay.
|
2863
|
+
# @return [String]
|
2864
|
+
#
|
2865
|
+
# @!attribute [rw] event_source_arn
|
2866
|
+
# The ARN of the archive to replay event from.
|
2867
|
+
# @return [String]
|
2868
|
+
#
|
2869
|
+
# @!attribute [rw] state
|
2870
|
+
# The current state of the replay.
|
2871
|
+
# @return [String]
|
2872
|
+
#
|
2873
|
+
# @!attribute [rw] state_reason
|
2874
|
+
# A description of why the replay is in the current state.
|
2875
|
+
# @return [String]
|
2876
|
+
#
|
2877
|
+
# @!attribute [rw] event_start_time
|
2878
|
+
# A time stamp for the time to start replaying events. This is
|
2879
|
+
# determined by the time in the event as described in [Time][1].
|
2880
|
+
#
|
2881
|
+
#
|
2882
|
+
#
|
2883
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEventsRequestEntry.html#eventbridge-Type-PutEventsRequestEntry-Time
|
2884
|
+
# @return [Time]
|
2885
|
+
#
|
2886
|
+
# @!attribute [rw] event_end_time
|
2887
|
+
# A time stamp for the time to start replaying events. Any event with
|
2888
|
+
# a creation time prior to the `EventEndTime` specified is replayed.
|
2889
|
+
# @return [Time]
|
2890
|
+
#
|
2891
|
+
# @!attribute [rw] event_last_replayed_time
|
2892
|
+
# A time stamp for the time that the last event was replayed.
|
2893
|
+
# @return [Time]
|
2894
|
+
#
|
2895
|
+
# @!attribute [rw] replay_start_time
|
2896
|
+
# A time stamp for the time that the replay started.
|
2897
|
+
# @return [Time]
|
2898
|
+
#
|
2899
|
+
# @!attribute [rw] replay_end_time
|
2900
|
+
# A time stamp for the time that the replay completed.
|
2901
|
+
# @return [Time]
|
2902
|
+
#
|
2903
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/Replay AWS API Documentation
|
2904
|
+
#
|
2905
|
+
class Replay < Struct.new(
|
2906
|
+
:replay_name,
|
2907
|
+
:event_source_arn,
|
2908
|
+
:state,
|
2909
|
+
:state_reason,
|
2910
|
+
:event_start_time,
|
2911
|
+
:event_end_time,
|
2912
|
+
:event_last_replayed_time,
|
2913
|
+
:replay_start_time,
|
2914
|
+
:replay_end_time)
|
2915
|
+
SENSITIVE = []
|
2916
|
+
include Aws::Structure
|
2917
|
+
end
|
2918
|
+
|
2919
|
+
# A `ReplayDestination` object that contains details about a replay.
|
2920
|
+
#
|
2921
|
+
# @note When making an API call, you may pass ReplayDestination
|
2922
|
+
# data as a hash:
|
2923
|
+
#
|
2924
|
+
# {
|
2925
|
+
# arn: "Arn", # required
|
2926
|
+
# filter_arns: ["Arn"],
|
2927
|
+
# }
|
2928
|
+
#
|
2929
|
+
# @!attribute [rw] arn
|
2930
|
+
# The ARN of the event bus to replay event to. You can replay events
|
2931
|
+
# only to the event bus specified to create the archive.
|
2932
|
+
# @return [String]
|
2933
|
+
#
|
2934
|
+
# @!attribute [rw] filter_arns
|
2935
|
+
# A list of ARNs for rules to replay events to.
|
2936
|
+
# @return [Array<String>]
|
2937
|
+
#
|
2938
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ReplayDestination AWS API Documentation
|
2939
|
+
#
|
2940
|
+
class ReplayDestination < Struct.new(
|
2941
|
+
:arn,
|
2942
|
+
:filter_arns)
|
2943
|
+
SENSITIVE = []
|
2944
|
+
include Aws::Structure
|
2945
|
+
end
|
2946
|
+
|
2297
2947
|
# The resource you are trying to create already exists.
|
2298
2948
|
#
|
2299
2949
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ResourceAlreadyExistsException AWS API Documentation
|
@@ -2306,6 +2956,38 @@ module Aws::CloudWatchEvents
|
|
2306
2956
|
#
|
2307
2957
|
class ResourceNotFoundException < Aws::EmptyStructure; end
|
2308
2958
|
|
2959
|
+
# A `RetryPolicy` object that includes information about the retry
|
2960
|
+
# policy settings.
|
2961
|
+
#
|
2962
|
+
# @note When making an API call, you may pass RetryPolicy
|
2963
|
+
# data as a hash:
|
2964
|
+
#
|
2965
|
+
# {
|
2966
|
+
# maximum_retry_attempts: 1,
|
2967
|
+
# maximum_event_age_in_seconds: 1,
|
2968
|
+
# }
|
2969
|
+
#
|
2970
|
+
# @!attribute [rw] maximum_retry_attempts
|
2971
|
+
# The maximum number of retry attempts to make before the request
|
2972
|
+
# fails. Retry attempts continue until either the maximum number of
|
2973
|
+
# attempts is made or until the duration of the
|
2974
|
+
# `MaximumEventAgeInSeconds` is met.
|
2975
|
+
# @return [Integer]
|
2976
|
+
#
|
2977
|
+
# @!attribute [rw] maximum_event_age_in_seconds
|
2978
|
+
# The maximum amount of time, in seconds, to continue to make retry
|
2979
|
+
# attempts.
|
2980
|
+
# @return [Integer]
|
2981
|
+
#
|
2982
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/RetryPolicy AWS API Documentation
|
2983
|
+
#
|
2984
|
+
class RetryPolicy < Struct.new(
|
2985
|
+
:maximum_retry_attempts,
|
2986
|
+
:maximum_event_age_in_seconds)
|
2987
|
+
SENSITIVE = []
|
2988
|
+
include Aws::Structure
|
2989
|
+
end
|
2990
|
+
|
2309
2991
|
# Contains information about a rule in Amazon EventBridge.
|
2310
2992
|
#
|
2311
2993
|
# @!attribute [rw] name
|
@@ -2350,7 +3032,8 @@ module Aws::CloudWatchEvents
|
|
2350
3032
|
# @return [String]
|
2351
3033
|
#
|
2352
3034
|
# @!attribute [rw] event_bus_name
|
2353
|
-
# The event bus associated with the rule.
|
3035
|
+
# The name or ARN of the event bus associated with the rule. If you
|
3036
|
+
# omit this, the default event bus is used.
|
2354
3037
|
# @return [String]
|
2355
3038
|
#
|
2356
3039
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/Rule AWS API Documentation
|
@@ -2450,6 +3133,90 @@ module Aws::CloudWatchEvents
|
|
2450
3133
|
include Aws::Structure
|
2451
3134
|
end
|
2452
3135
|
|
3136
|
+
# @note When making an API call, you may pass StartReplayRequest
|
3137
|
+
# data as a hash:
|
3138
|
+
#
|
3139
|
+
# {
|
3140
|
+
# replay_name: "ReplayName", # required
|
3141
|
+
# description: "ReplayDescription",
|
3142
|
+
# event_source_arn: "Arn", # required
|
3143
|
+
# event_start_time: Time.now, # required
|
3144
|
+
# event_end_time: Time.now, # required
|
3145
|
+
# destination: { # required
|
3146
|
+
# arn: "Arn", # required
|
3147
|
+
# filter_arns: ["Arn"],
|
3148
|
+
# },
|
3149
|
+
# }
|
3150
|
+
#
|
3151
|
+
# @!attribute [rw] replay_name
|
3152
|
+
# The name of the replay to start.
|
3153
|
+
# @return [String]
|
3154
|
+
#
|
3155
|
+
# @!attribute [rw] description
|
3156
|
+
# A description for the replay to start.
|
3157
|
+
# @return [String]
|
3158
|
+
#
|
3159
|
+
# @!attribute [rw] event_source_arn
|
3160
|
+
# The ARN of the archive to replay events from.
|
3161
|
+
# @return [String]
|
3162
|
+
#
|
3163
|
+
# @!attribute [rw] event_start_time
|
3164
|
+
# A time stamp for the time to start replaying events. Only events
|
3165
|
+
# that occurred between the `EventStartTime` and `EventEndTime` are
|
3166
|
+
# replayed.
|
3167
|
+
# @return [Time]
|
3168
|
+
#
|
3169
|
+
# @!attribute [rw] event_end_time
|
3170
|
+
# A time stamp for the time to stop replaying events. Only events that
|
3171
|
+
# occurred between the `EventStartTime` and `EventEndTime` are
|
3172
|
+
# replayed.
|
3173
|
+
# @return [Time]
|
3174
|
+
#
|
3175
|
+
# @!attribute [rw] destination
|
3176
|
+
# A `ReplayDestination` object that includes details about the
|
3177
|
+
# destination for the replay.
|
3178
|
+
# @return [Types::ReplayDestination]
|
3179
|
+
#
|
3180
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/StartReplayRequest AWS API Documentation
|
3181
|
+
#
|
3182
|
+
class StartReplayRequest < Struct.new(
|
3183
|
+
:replay_name,
|
3184
|
+
:description,
|
3185
|
+
:event_source_arn,
|
3186
|
+
:event_start_time,
|
3187
|
+
:event_end_time,
|
3188
|
+
:destination)
|
3189
|
+
SENSITIVE = []
|
3190
|
+
include Aws::Structure
|
3191
|
+
end
|
3192
|
+
|
3193
|
+
# @!attribute [rw] replay_arn
|
3194
|
+
# The ARN of the replay.
|
3195
|
+
# @return [String]
|
3196
|
+
#
|
3197
|
+
# @!attribute [rw] state
|
3198
|
+
# The state of the replay.
|
3199
|
+
# @return [String]
|
3200
|
+
#
|
3201
|
+
# @!attribute [rw] state_reason
|
3202
|
+
# The reason that the replay is in the state.
|
3203
|
+
# @return [String]
|
3204
|
+
#
|
3205
|
+
# @!attribute [rw] replay_start_time
|
3206
|
+
# The time at which the replay started.
|
3207
|
+
# @return [Time]
|
3208
|
+
#
|
3209
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/StartReplayResponse AWS API Documentation
|
3210
|
+
#
|
3211
|
+
class StartReplayResponse < Struct.new(
|
3212
|
+
:replay_arn,
|
3213
|
+
:state,
|
3214
|
+
:state_reason,
|
3215
|
+
:replay_start_time)
|
3216
|
+
SENSITIVE = []
|
3217
|
+
include Aws::Structure
|
3218
|
+
end
|
3219
|
+
|
2453
3220
|
# A key-value pair associated with an AWS resource. In EventBridge,
|
2454
3221
|
# rules and event buses support tagging.
|
2455
3222
|
#
|
@@ -2598,6 +3365,13 @@ module Aws::CloudWatchEvents
|
|
2598
3365
|
# statement_name: "StatementName",
|
2599
3366
|
# with_event: false,
|
2600
3367
|
# },
|
3368
|
+
# dead_letter_config: {
|
3369
|
+
# arn: "ResourceArn",
|
3370
|
+
# },
|
3371
|
+
# retry_policy: {
|
3372
|
+
# maximum_retry_attempts: 1,
|
3373
|
+
# maximum_event_age_in_seconds: 1,
|
3374
|
+
# },
|
2601
3375
|
# }
|
2602
3376
|
#
|
2603
3377
|
# @!attribute [rw] id
|
@@ -2700,6 +3474,16 @@ module Aws::CloudWatchEvents
|
|
2700
3474
|
# based on EventBridge events.
|
2701
3475
|
# @return [Types::RedshiftDataParameters]
|
2702
3476
|
#
|
3477
|
+
# @!attribute [rw] dead_letter_config
|
3478
|
+
# The `DeadLetterConfig` that defines the target queue to send
|
3479
|
+
# dead-letter queue events to.
|
3480
|
+
# @return [Types::DeadLetterConfig]
|
3481
|
+
#
|
3482
|
+
# @!attribute [rw] retry_policy
|
3483
|
+
# The `RetryPolicy` object that contains the retry policy
|
3484
|
+
# configuration to use for the dead-letter queue.
|
3485
|
+
# @return [Types::RetryPolicy]
|
3486
|
+
#
|
2703
3487
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/Target AWS API Documentation
|
2704
3488
|
#
|
2705
3489
|
class Target < Struct.new(
|
@@ -2715,7 +3499,9 @@ module Aws::CloudWatchEvents
|
|
2715
3499
|
:batch_parameters,
|
2716
3500
|
:sqs_parameters,
|
2717
3501
|
:http_parameters,
|
2718
|
-
:redshift_data_parameters
|
3502
|
+
:redshift_data_parameters,
|
3503
|
+
:dead_letter_config,
|
3504
|
+
:retry_policy)
|
2719
3505
|
SENSITIVE = []
|
2720
3506
|
include Aws::Structure
|
2721
3507
|
end
|
@@ -2738,7 +3524,27 @@ module Aws::CloudWatchEvents
|
|
2738
3524
|
# @return [String]
|
2739
3525
|
#
|
2740
3526
|
# @!attribute [rw] event
|
2741
|
-
# The event, in JSON format, to test against the event pattern.
|
3527
|
+
# The event, in JSON format, to test against the event pattern. The
|
3528
|
+
# JSON must follow the format specified in [AWS Events][1], and the
|
3529
|
+
# following fields are mandatory:
|
3530
|
+
#
|
3531
|
+
# * `id`
|
3532
|
+
#
|
3533
|
+
# * `account`
|
3534
|
+
#
|
3535
|
+
# * `source`
|
3536
|
+
#
|
3537
|
+
# * `time`
|
3538
|
+
#
|
3539
|
+
# * `region`
|
3540
|
+
#
|
3541
|
+
# * `resources`
|
3542
|
+
#
|
3543
|
+
# * `detail-type`
|
3544
|
+
#
|
3545
|
+
#
|
3546
|
+
#
|
3547
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html
|
2742
3548
|
# @return [String]
|
2743
3549
|
#
|
2744
3550
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/TestEventPatternRequest AWS API Documentation
|
@@ -2792,5 +3598,69 @@ module Aws::CloudWatchEvents
|
|
2792
3598
|
#
|
2793
3599
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
2794
3600
|
|
3601
|
+
# @note When making an API call, you may pass UpdateArchiveRequest
|
3602
|
+
# data as a hash:
|
3603
|
+
#
|
3604
|
+
# {
|
3605
|
+
# archive_name: "ArchiveName", # required
|
3606
|
+
# description: "ArchiveDescription",
|
3607
|
+
# event_pattern: "EventPattern",
|
3608
|
+
# retention_days: 1,
|
3609
|
+
# }
|
3610
|
+
#
|
3611
|
+
# @!attribute [rw] archive_name
|
3612
|
+
# The name of the archive to update.
|
3613
|
+
# @return [String]
|
3614
|
+
#
|
3615
|
+
# @!attribute [rw] description
|
3616
|
+
# The description for the archive.
|
3617
|
+
# @return [String]
|
3618
|
+
#
|
3619
|
+
# @!attribute [rw] event_pattern
|
3620
|
+
# The event pattern to use to filter events sent to the archive.
|
3621
|
+
# @return [String]
|
3622
|
+
#
|
3623
|
+
# @!attribute [rw] retention_days
|
3624
|
+
# The number of days to retain events in the archive.
|
3625
|
+
# @return [Integer]
|
3626
|
+
#
|
3627
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateArchiveRequest AWS API Documentation
|
3628
|
+
#
|
3629
|
+
class UpdateArchiveRequest < Struct.new(
|
3630
|
+
:archive_name,
|
3631
|
+
:description,
|
3632
|
+
:event_pattern,
|
3633
|
+
:retention_days)
|
3634
|
+
SENSITIVE = []
|
3635
|
+
include Aws::Structure
|
3636
|
+
end
|
3637
|
+
|
3638
|
+
# @!attribute [rw] archive_arn
|
3639
|
+
# The ARN of the archive.
|
3640
|
+
# @return [String]
|
3641
|
+
#
|
3642
|
+
# @!attribute [rw] state
|
3643
|
+
# The state of the archive.
|
3644
|
+
# @return [String]
|
3645
|
+
#
|
3646
|
+
# @!attribute [rw] state_reason
|
3647
|
+
# The reason that the archive is in the current state.
|
3648
|
+
# @return [String]
|
3649
|
+
#
|
3650
|
+
# @!attribute [rw] creation_time
|
3651
|
+
# The time at which the archive was updated.
|
3652
|
+
# @return [Time]
|
3653
|
+
#
|
3654
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateArchiveResponse AWS API Documentation
|
3655
|
+
#
|
3656
|
+
class UpdateArchiveResponse < Struct.new(
|
3657
|
+
:archive_arn,
|
3658
|
+
:state,
|
3659
|
+
:state_reason,
|
3660
|
+
:creation_time)
|
3661
|
+
SENSITIVE = []
|
3662
|
+
include Aws::Structure
|
3663
|
+
end
|
3664
|
+
|
2795
3665
|
end
|
2796
3666
|
end
|