aws-sdk-cloudwatchevents 1.36.0 → 1.41.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 69bbf267aab4889d1ad7d5ede0360a5c403edfe4f948d2f21efd2c8f9e62e512
4
- data.tar.gz: '0084036485379612e10fa8428181a2d53aff62e96ac247bbe0e900efdf292b9c'
3
+ metadata.gz: 3f9e768480073910b9434d4802e42a38e5631ebfb447a2c795d9fe7be75cb9a8
4
+ data.tar.gz: ae28fd626f074b1bd6235456b6f4a112a5587314968ace34831c5ef9ec083979
5
5
  SHA512:
6
- metadata.gz: 8f85b7263a81e5cd548f06316b8a476c2c2d03e07a8967039123bdfab6cc6acc0d8774c63f27c0c0cb74b1c67162dd25ea9244929c3b88ad63fec00b16435f65
7
- data.tar.gz: '04844b15c054af22da8e2ab17d158bcc3f0ed19af9e8064911b80ebc04645c4ea09be59fb7846c1d84619a63ed1326673c32f775f964289957be6e636114baf8'
6
+ metadata.gz: 4ad2b0451a20a4a2ca6dc75ca9d7a648f89418331c470c659a1046afc84c553568613cb52449d4c3fc7ad1548eb25c7e65982f5a9c04f3380c7b8486947a924d
7
+ data.tar.gz: a500d975e064c6512da9a28650608457bf18e2ad21fe0df7c4a7449c3b825e025d608674d1c489f40b6371569070354e068bba305bcae295772835aebb0577a9
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-cloudwatchevents/customizations'
48
48
  # @!group service
49
49
  module Aws::CloudWatchEvents
50
50
 
51
- GEM_VERSION = '1.36.0'
51
+ GEM_VERSION = '1.41.0'
52
52
 
53
53
  end
@@ -361,6 +361,94 @@ module Aws::CloudWatchEvents
361
361
  req.send_request(options)
362
362
  end
363
363
 
364
+ # Cancels the specified replay.
365
+ #
366
+ # @option params [required, String] :replay_name
367
+ # The name of the replay to cancel.
368
+ #
369
+ # @return [Types::CancelReplayResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
370
+ #
371
+ # * {Types::CancelReplayResponse#replay_arn #replay_arn} => String
372
+ # * {Types::CancelReplayResponse#state #state} => String
373
+ # * {Types::CancelReplayResponse#state_reason #state_reason} => String
374
+ #
375
+ # @example Request syntax with placeholder values
376
+ #
377
+ # resp = client.cancel_replay({
378
+ # replay_name: "ReplayName", # required
379
+ # })
380
+ #
381
+ # @example Response structure
382
+ #
383
+ # resp.replay_arn #=> String
384
+ # resp.state #=> String, one of "STARTING", "RUNNING", "CANCELLING", "COMPLETED", "CANCELLED", "FAILED"
385
+ # resp.state_reason #=> String
386
+ #
387
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CancelReplay AWS API Documentation
388
+ #
389
+ # @overload cancel_replay(params = {})
390
+ # @param [Hash] params ({})
391
+ def cancel_replay(params = {}, options = {})
392
+ req = build_request(:cancel_replay, params)
393
+ req.send_request(options)
394
+ end
395
+
396
+ # Creates an archive of events with the specified settings. When you
397
+ # create an archive, incoming events might not immediately start being
398
+ # sent to the archive. Allow a short period of time for changes to take
399
+ # effect. If you do not specify a pattern to filter events sent to the
400
+ # archive, all events are sent to the archive except replayed events.
401
+ # Replayed events are not sent to an archive.
402
+ #
403
+ # @option params [required, String] :archive_name
404
+ # The name for the archive to create.
405
+ #
406
+ # @option params [required, String] :event_source_arn
407
+ # The ARN of the event source associated with the archive.
408
+ #
409
+ # @option params [String] :description
410
+ # A description for the archive.
411
+ #
412
+ # @option params [String] :event_pattern
413
+ # An event pattern to use to filter events sent to the archive.
414
+ #
415
+ # @option params [Integer] :retention_days
416
+ # The number of days to retain events for. Default value is 0. If set to
417
+ # 0, events are retained indefinitely
418
+ #
419
+ # @return [Types::CreateArchiveResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
420
+ #
421
+ # * {Types::CreateArchiveResponse#archive_arn #archive_arn} => String
422
+ # * {Types::CreateArchiveResponse#state #state} => String
423
+ # * {Types::CreateArchiveResponse#state_reason #state_reason} => String
424
+ # * {Types::CreateArchiveResponse#creation_time #creation_time} => Time
425
+ #
426
+ # @example Request syntax with placeholder values
427
+ #
428
+ # resp = client.create_archive({
429
+ # archive_name: "ArchiveName", # required
430
+ # event_source_arn: "Arn", # required
431
+ # description: "ArchiveDescription",
432
+ # event_pattern: "EventPattern",
433
+ # retention_days: 1,
434
+ # })
435
+ #
436
+ # @example Response structure
437
+ #
438
+ # resp.archive_arn #=> String
439
+ # resp.state #=> String, one of "ENABLED", "DISABLED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
440
+ # resp.state_reason #=> String
441
+ # resp.creation_time #=> Time
442
+ #
443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateArchive AWS API Documentation
444
+ #
445
+ # @overload create_archive(params = {})
446
+ # @param [Hash] params ({})
447
+ def create_archive(params = {}, options = {})
448
+ req = build_request(:create_archive, params)
449
+ req.send_request(options)
450
+ end
451
+
364
452
  # Creates a new event bus within your account. This can be a custom
365
453
  # event bus which you can use to receive events from your custom
366
454
  # applications and services, or it can be a partner event bus which can
@@ -507,6 +595,28 @@ module Aws::CloudWatchEvents
507
595
  req.send_request(options)
508
596
  end
509
597
 
598
+ # Deletes the specified archive.
599
+ #
600
+ # @option params [required, String] :archive_name
601
+ # The name of the archive to delete.
602
+ #
603
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
604
+ #
605
+ # @example Request syntax with placeholder values
606
+ #
607
+ # resp = client.delete_archive({
608
+ # archive_name: "ArchiveName", # required
609
+ # })
610
+ #
611
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteArchive AWS API Documentation
612
+ #
613
+ # @overload delete_archive(params = {})
614
+ # @param [Hash] params ({})
615
+ def delete_archive(params = {}, options = {})
616
+ req = build_request(:delete_archive, params)
617
+ req.send_request(options)
618
+ end
619
+
510
620
  # Deletes the specified custom event bus or partner event bus. All rules
511
621
  # associated with this event bus need to be deleted. You can't delete
512
622
  # your account's default event bus.
@@ -580,8 +690,8 @@ module Aws::CloudWatchEvents
580
690
  # The name of the rule.
581
691
  #
582
692
  # @option params [String] :event_bus_name
583
- # The event bus associated with the rule. If you omit this, the default
584
- # event bus is used.
693
+ # The name or ARN of the event bus associated with the rule. If you omit
694
+ # this, the default event bus is used.
585
695
  #
586
696
  # @option params [Boolean] :force
587
697
  # If this is a managed rule, created by an AWS service on your behalf,
@@ -596,7 +706,7 @@ module Aws::CloudWatchEvents
596
706
  #
597
707
  # resp = client.delete_rule({
598
708
  # name: "RuleName", # required
599
- # event_bus_name: "EventBusName",
709
+ # event_bus_name: "EventBusNameOrArn",
600
710
  # force: false,
601
711
  # })
602
712
  #
@@ -609,6 +719,54 @@ module Aws::CloudWatchEvents
609
719
  req.send_request(options)
610
720
  end
611
721
 
722
+ # Retrieves details about an archive.
723
+ #
724
+ # @option params [required, String] :archive_name
725
+ # The name of the archive to retrieve.
726
+ #
727
+ # @return [Types::DescribeArchiveResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
728
+ #
729
+ # * {Types::DescribeArchiveResponse#archive_arn #archive_arn} => String
730
+ # * {Types::DescribeArchiveResponse#archive_name #archive_name} => String
731
+ # * {Types::DescribeArchiveResponse#event_source_arn #event_source_arn} => String
732
+ # * {Types::DescribeArchiveResponse#description #description} => String
733
+ # * {Types::DescribeArchiveResponse#event_pattern #event_pattern} => String
734
+ # * {Types::DescribeArchiveResponse#state #state} => String
735
+ # * {Types::DescribeArchiveResponse#state_reason #state_reason} => String
736
+ # * {Types::DescribeArchiveResponse#retention_days #retention_days} => Integer
737
+ # * {Types::DescribeArchiveResponse#size_bytes #size_bytes} => Integer
738
+ # * {Types::DescribeArchiveResponse#event_count #event_count} => Integer
739
+ # * {Types::DescribeArchiveResponse#creation_time #creation_time} => Time
740
+ #
741
+ # @example Request syntax with placeholder values
742
+ #
743
+ # resp = client.describe_archive({
744
+ # archive_name: "ArchiveName", # required
745
+ # })
746
+ #
747
+ # @example Response structure
748
+ #
749
+ # resp.archive_arn #=> String
750
+ # resp.archive_name #=> String
751
+ # resp.event_source_arn #=> String
752
+ # resp.description #=> String
753
+ # resp.event_pattern #=> String
754
+ # resp.state #=> String, one of "ENABLED", "DISABLED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
755
+ # resp.state_reason #=> String
756
+ # resp.retention_days #=> Integer
757
+ # resp.size_bytes #=> Integer
758
+ # resp.event_count #=> Integer
759
+ # resp.creation_time #=> Time
760
+ #
761
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeArchive AWS API Documentation
762
+ #
763
+ # @overload describe_archive(params = {})
764
+ # @param [Hash] params ({})
765
+ def describe_archive(params = {}, options = {})
766
+ req = build_request(:describe_archive, params)
767
+ req.send_request(options)
768
+ end
769
+
612
770
  # Displays details about an event bus in your account. This can include
613
771
  # the external AWS accounts that are permitted to write events to your
614
772
  # default event bus, and the associated policy. For custom event buses
@@ -621,8 +779,8 @@ module Aws::CloudWatchEvents
621
779
  # For more information about partner event buses, see CreateEventBus.
622
780
  #
623
781
  # @option params [String] :name
624
- # The name of the event bus to show details for. If you omit this, the
625
- # default event bus is displayed.
782
+ # The name or ARN of the event bus to show details for. If you omit
783
+ # this, the default event bus is displayed.
626
784
  #
627
785
  # @return [Types::DescribeEventBusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
628
786
  #
@@ -633,7 +791,7 @@ module Aws::CloudWatchEvents
633
791
  # @example Request syntax with placeholder values
634
792
  #
635
793
  # resp = client.describe_event_bus({
636
- # name: "EventBusName",
794
+ # name: "EventBusNameOrArn",
637
795
  # })
638
796
  #
639
797
  # @example Response structure
@@ -723,6 +881,67 @@ module Aws::CloudWatchEvents
723
881
  req.send_request(options)
724
882
  end
725
883
 
884
+ # Retrieves details about a replay. Use `DescribeReplay` to determine
885
+ # the progress of a running replay. A replay processes events to replay
886
+ # based on the time in the event, and replays them using 1 minute
887
+ # intervals. If you use `StartReplay` and specify an `EventStartTime`
888
+ # and an `EventEndTime` that covers a 20 minute time range, the events
889
+ # are replayed from the first minute of that 20 minute range first. Then
890
+ # the events from the second minute are replayed. You can use
891
+ # `DescribeReplay` to determine the progress of a replay. The value
892
+ # returned for `EventLastReplayedTime` indicates the time within the
893
+ # specified time range associated with the last event replayed.
894
+ #
895
+ # @option params [required, String] :replay_name
896
+ # The name of the replay to retrieve.
897
+ #
898
+ # @return [Types::DescribeReplayResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
899
+ #
900
+ # * {Types::DescribeReplayResponse#replay_name #replay_name} => String
901
+ # * {Types::DescribeReplayResponse#replay_arn #replay_arn} => String
902
+ # * {Types::DescribeReplayResponse#description #description} => String
903
+ # * {Types::DescribeReplayResponse#state #state} => String
904
+ # * {Types::DescribeReplayResponse#state_reason #state_reason} => String
905
+ # * {Types::DescribeReplayResponse#event_source_arn #event_source_arn} => String
906
+ # * {Types::DescribeReplayResponse#destination #destination} => Types::ReplayDestination
907
+ # * {Types::DescribeReplayResponse#event_start_time #event_start_time} => Time
908
+ # * {Types::DescribeReplayResponse#event_end_time #event_end_time} => Time
909
+ # * {Types::DescribeReplayResponse#event_last_replayed_time #event_last_replayed_time} => Time
910
+ # * {Types::DescribeReplayResponse#replay_start_time #replay_start_time} => Time
911
+ # * {Types::DescribeReplayResponse#replay_end_time #replay_end_time} => Time
912
+ #
913
+ # @example Request syntax with placeholder values
914
+ #
915
+ # resp = client.describe_replay({
916
+ # replay_name: "ReplayName", # required
917
+ # })
918
+ #
919
+ # @example Response structure
920
+ #
921
+ # resp.replay_name #=> String
922
+ # resp.replay_arn #=> String
923
+ # resp.description #=> String
924
+ # resp.state #=> String, one of "STARTING", "RUNNING", "CANCELLING", "COMPLETED", "CANCELLED", "FAILED"
925
+ # resp.state_reason #=> String
926
+ # resp.event_source_arn #=> String
927
+ # resp.destination.arn #=> String
928
+ # resp.destination.filter_arns #=> Array
929
+ # resp.destination.filter_arns[0] #=> String
930
+ # resp.event_start_time #=> Time
931
+ # resp.event_end_time #=> Time
932
+ # resp.event_last_replayed_time #=> Time
933
+ # resp.replay_start_time #=> Time
934
+ # resp.replay_end_time #=> Time
935
+ #
936
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeReplay AWS API Documentation
937
+ #
938
+ # @overload describe_replay(params = {})
939
+ # @param [Hash] params ({})
940
+ def describe_replay(params = {}, options = {})
941
+ req = build_request(:describe_replay, params)
942
+ req.send_request(options)
943
+ end
944
+
726
945
  # Describes the specified rule.
727
946
  #
728
947
  # DescribeRule does not list the targets of a rule. To see the targets
@@ -732,8 +951,8 @@ module Aws::CloudWatchEvents
732
951
  # The name of the rule.
733
952
  #
734
953
  # @option params [String] :event_bus_name
735
- # The event bus associated with the rule. If you omit this, the default
736
- # event bus is used.
954
+ # The name or ARN of the event bus associated with the rule. If you omit
955
+ # this, the default event bus is used.
737
956
  #
738
957
  # @return [Types::DescribeRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
739
958
  #
@@ -746,12 +965,13 @@ module Aws::CloudWatchEvents
746
965
  # * {Types::DescribeRuleResponse#role_arn #role_arn} => String
747
966
  # * {Types::DescribeRuleResponse#managed_by #managed_by} => String
748
967
  # * {Types::DescribeRuleResponse#event_bus_name #event_bus_name} => String
968
+ # * {Types::DescribeRuleResponse#created_by #created_by} => String
749
969
  #
750
970
  # @example Request syntax with placeholder values
751
971
  #
752
972
  # resp = client.describe_rule({
753
973
  # name: "RuleName", # required
754
- # event_bus_name: "EventBusName",
974
+ # event_bus_name: "EventBusNameOrArn",
755
975
  # })
756
976
  #
757
977
  # @example Response structure
@@ -765,6 +985,7 @@ module Aws::CloudWatchEvents
765
985
  # resp.role_arn #=> String
766
986
  # resp.managed_by #=> String
767
987
  # resp.event_bus_name #=> String
988
+ # resp.created_by #=> String
768
989
  #
769
990
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeRule AWS API Documentation
770
991
  #
@@ -786,8 +1007,8 @@ module Aws::CloudWatchEvents
786
1007
  # The name of the rule.
787
1008
  #
788
1009
  # @option params [String] :event_bus_name
789
- # The event bus associated with the rule. If you omit this, the default
790
- # event bus is used.
1010
+ # The name or ARN of the event bus associated with the rule. If you omit
1011
+ # this, the default event bus is used.
791
1012
  #
792
1013
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
793
1014
  #
@@ -795,7 +1016,7 @@ module Aws::CloudWatchEvents
795
1016
  #
796
1017
  # resp = client.disable_rule({
797
1018
  # name: "RuleName", # required
798
- # event_bus_name: "EventBusName",
1019
+ # event_bus_name: "EventBusNameOrArn",
799
1020
  # })
800
1021
  #
801
1022
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DisableRule AWS API Documentation
@@ -818,8 +1039,8 @@ module Aws::CloudWatchEvents
818
1039
  # The name of the rule.
819
1040
  #
820
1041
  # @option params [String] :event_bus_name
821
- # The event bus associated with the rule. If you omit this, the default
822
- # event bus is used.
1042
+ # The name or ARN of the event bus associated with the rule. If you omit
1043
+ # this, the default event bus is used.
823
1044
  #
824
1045
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
825
1046
  #
@@ -827,7 +1048,7 @@ module Aws::CloudWatchEvents
827
1048
  #
828
1049
  # resp = client.enable_rule({
829
1050
  # name: "RuleName", # required
830
- # event_bus_name: "EventBusName",
1051
+ # event_bus_name: "EventBusNameOrArn",
831
1052
  # })
832
1053
  #
833
1054
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/EnableRule AWS API Documentation
@@ -839,6 +1060,64 @@ module Aws::CloudWatchEvents
839
1060
  req.send_request(options)
840
1061
  end
841
1062
 
1063
+ # Lists your archives. You can either list all the archives or you can
1064
+ # provide a prefix to match to the archive names. Filter parameters are
1065
+ # exclusive.
1066
+ #
1067
+ # @option params [String] :name_prefix
1068
+ # A name prefix to filter the archives returned. Only archives with name
1069
+ # that match the prefix are returned.
1070
+ #
1071
+ # @option params [String] :event_source_arn
1072
+ # The ARN of the event source associated with the archive.
1073
+ #
1074
+ # @option params [String] :state
1075
+ # The state of the archive.
1076
+ #
1077
+ # @option params [String] :next_token
1078
+ # The token returned by a previous call to retrieve the next set of
1079
+ # results.
1080
+ #
1081
+ # @option params [Integer] :limit
1082
+ # The maximum number of results to return.
1083
+ #
1084
+ # @return [Types::ListArchivesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1085
+ #
1086
+ # * {Types::ListArchivesResponse#archives #archives} => Array<Types::Archive>
1087
+ # * {Types::ListArchivesResponse#next_token #next_token} => String
1088
+ #
1089
+ # @example Request syntax with placeholder values
1090
+ #
1091
+ # resp = client.list_archives({
1092
+ # name_prefix: "ArchiveName",
1093
+ # event_source_arn: "Arn",
1094
+ # state: "ENABLED", # accepts ENABLED, DISABLED, CREATING, UPDATING, CREATE_FAILED, UPDATE_FAILED
1095
+ # next_token: "NextToken",
1096
+ # limit: 1,
1097
+ # })
1098
+ #
1099
+ # @example Response structure
1100
+ #
1101
+ # resp.archives #=> Array
1102
+ # resp.archives[0].archive_name #=> String
1103
+ # resp.archives[0].event_source_arn #=> String
1104
+ # resp.archives[0].state #=> String, one of "ENABLED", "DISABLED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
1105
+ # resp.archives[0].state_reason #=> String
1106
+ # resp.archives[0].retention_days #=> Integer
1107
+ # resp.archives[0].size_bytes #=> Integer
1108
+ # resp.archives[0].event_count #=> Integer
1109
+ # resp.archives[0].creation_time #=> Time
1110
+ # resp.next_token #=> String
1111
+ #
1112
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListArchives AWS API Documentation
1113
+ #
1114
+ # @overload list_archives(params = {})
1115
+ # @param [Hash] params ({})
1116
+ def list_archives(params = {}, options = {})
1117
+ req = build_request(:list_archives, params)
1118
+ req.send_request(options)
1119
+ end
1120
+
842
1121
  # Lists all the event buses in your account, including the default event
843
1122
  # bus, custom event buses, and partner event buses.
844
1123
  #
@@ -1029,6 +1308,65 @@ module Aws::CloudWatchEvents
1029
1308
  req.send_request(options)
1030
1309
  end
1031
1310
 
1311
+ # Lists your replays. You can either list all the replays or you can
1312
+ # provide a prefix to match to the replay names. Filter parameters are
1313
+ # exclusive.
1314
+ #
1315
+ # @option params [String] :name_prefix
1316
+ # A name prefix to filter the replays returned. Only replays with name
1317
+ # that match the prefix are returned.
1318
+ #
1319
+ # @option params [String] :state
1320
+ # The state of the replay.
1321
+ #
1322
+ # @option params [String] :event_source_arn
1323
+ # The ARN of the event source associated with the replay.
1324
+ #
1325
+ # @option params [String] :next_token
1326
+ # The token returned by a previous call to retrieve the next set of
1327
+ # results.
1328
+ #
1329
+ # @option params [Integer] :limit
1330
+ # The maximum number of replays to retrieve.
1331
+ #
1332
+ # @return [Types::ListReplaysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1333
+ #
1334
+ # * {Types::ListReplaysResponse#replays #replays} => Array<Types::Replay>
1335
+ # * {Types::ListReplaysResponse#next_token #next_token} => String
1336
+ #
1337
+ # @example Request syntax with placeholder values
1338
+ #
1339
+ # resp = client.list_replays({
1340
+ # name_prefix: "ReplayName",
1341
+ # state: "STARTING", # accepts STARTING, RUNNING, CANCELLING, COMPLETED, CANCELLED, FAILED
1342
+ # event_source_arn: "Arn",
1343
+ # next_token: "NextToken",
1344
+ # limit: 1,
1345
+ # })
1346
+ #
1347
+ # @example Response structure
1348
+ #
1349
+ # resp.replays #=> Array
1350
+ # resp.replays[0].replay_name #=> String
1351
+ # resp.replays[0].event_source_arn #=> String
1352
+ # resp.replays[0].state #=> String, one of "STARTING", "RUNNING", "CANCELLING", "COMPLETED", "CANCELLED", "FAILED"
1353
+ # resp.replays[0].state_reason #=> String
1354
+ # resp.replays[0].event_start_time #=> Time
1355
+ # resp.replays[0].event_end_time #=> Time
1356
+ # resp.replays[0].event_last_replayed_time #=> Time
1357
+ # resp.replays[0].replay_start_time #=> Time
1358
+ # resp.replays[0].replay_end_time #=> Time
1359
+ # resp.next_token #=> String
1360
+ #
1361
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListReplays AWS API Documentation
1362
+ #
1363
+ # @overload list_replays(params = {})
1364
+ # @param [Hash] params ({})
1365
+ def list_replays(params = {}, options = {})
1366
+ req = build_request(:list_replays, params)
1367
+ req.send_request(options)
1368
+ end
1369
+
1032
1370
  # Lists the rules for the specified target. You can see which of the
1033
1371
  # rules in Amazon EventBridge can invoke a specific target in your
1034
1372
  # account.
@@ -1037,8 +1375,8 @@ module Aws::CloudWatchEvents
1037
1375
  # The Amazon Resource Name (ARN) of the target resource.
1038
1376
  #
1039
1377
  # @option params [String] :event_bus_name
1040
- # Limits the results to show only the rules associated with the
1041
- # specified event bus.
1378
+ # The name or ARN of the event bus to list rules for. If you omit this,
1379
+ # the default event bus is used.
1042
1380
  #
1043
1381
  # @option params [String] :next_token
1044
1382
  # The token returned by a previous call to retrieve the next set of
@@ -1056,7 +1394,7 @@ module Aws::CloudWatchEvents
1056
1394
  #
1057
1395
  # resp = client.list_rule_names_by_target({
1058
1396
  # target_arn: "TargetArn", # required
1059
- # event_bus_name: "EventBusName",
1397
+ # event_bus_name: "EventBusNameOrArn",
1060
1398
  # next_token: "NextToken",
1061
1399
  # limit: 1,
1062
1400
  # })
@@ -1086,8 +1424,8 @@ module Aws::CloudWatchEvents
1086
1424
  # The prefix matching the rule name.
1087
1425
  #
1088
1426
  # @option params [String] :event_bus_name
1089
- # Limits the results to show only the rules associated with the
1090
- # specified event bus.
1427
+ # The name or ARN of the event bus to list the rules for. If you omit
1428
+ # this, the default event bus is used.
1091
1429
  #
1092
1430
  # @option params [String] :next_token
1093
1431
  # The token returned by a previous call to retrieve the next set of
@@ -1105,7 +1443,7 @@ module Aws::CloudWatchEvents
1105
1443
  #
1106
1444
  # resp = client.list_rules({
1107
1445
  # name_prefix: "RuleName",
1108
- # event_bus_name: "EventBusName",
1446
+ # event_bus_name: "EventBusNameOrArn",
1109
1447
  # next_token: "NextToken",
1110
1448
  # limit: 1,
1111
1449
  # })
@@ -1170,8 +1508,8 @@ module Aws::CloudWatchEvents
1170
1508
  # The name of the rule.
1171
1509
  #
1172
1510
  # @option params [String] :event_bus_name
1173
- # The event bus associated with the rule. If you omit this, the default
1174
- # event bus is used.
1511
+ # The name or ARN of the event bus associated with the rule. If you omit
1512
+ # this, the default event bus is used.
1175
1513
  #
1176
1514
  # @option params [String] :next_token
1177
1515
  # The token returned by a previous call to retrieve the next set of
@@ -1189,7 +1527,7 @@ module Aws::CloudWatchEvents
1189
1527
  #
1190
1528
  # resp = client.list_targets_by_rule({
1191
1529
  # rule: "RuleName", # required
1192
- # event_bus_name: "EventBusName",
1530
+ # event_bus_name: "EventBusNameOrArn",
1193
1531
  # next_token: "NextToken",
1194
1532
  # limit: 1,
1195
1533
  # })
@@ -1237,6 +1575,9 @@ module Aws::CloudWatchEvents
1237
1575
  # resp.targets[0].redshift_data_parameters.sql #=> String
1238
1576
  # resp.targets[0].redshift_data_parameters.statement_name #=> String
1239
1577
  # resp.targets[0].redshift_data_parameters.with_event #=> Boolean
1578
+ # resp.targets[0].dead_letter_config.arn #=> String
1579
+ # resp.targets[0].retry_policy.maximum_retry_attempts #=> Integer
1580
+ # resp.targets[0].retry_policy.maximum_event_age_in_seconds #=> Integer
1240
1581
  # resp.next_token #=> String
1241
1582
  #
1242
1583
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListTargetsByRule AWS API Documentation
@@ -1271,7 +1612,7 @@ module Aws::CloudWatchEvents
1271
1612
  # resources: ["EventResource"],
1272
1613
  # detail_type: "String",
1273
1614
  # detail: "String",
1274
- # event_bus_name: "NonPartnerEventBusName",
1615
+ # event_bus_name: "NonPartnerEventBusNameOrArn",
1275
1616
  # },
1276
1617
  # ],
1277
1618
  # })
@@ -1365,14 +1706,14 @@ module Aws::CloudWatchEvents
1365
1706
  # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
1366
1707
  #
1367
1708
  # @option params [String] :event_bus_name
1368
- # The event bus associated with the rule. If you omit this, the default
1369
- # event bus is used.
1709
+ # The name of the event bus associated with the rule. If you omit this,
1710
+ # the default event bus is used.
1370
1711
  #
1371
- # @option params [required, String] :action
1712
+ # @option params [String] :action
1372
1713
  # The action that you are enabling the other account to perform.
1373
1714
  # Currently, this must be `events:PutEvents`.
1374
1715
  #
1375
- # @option params [required, String] :principal
1716
+ # @option params [String] :principal
1376
1717
  # The 12-digit AWS account ID that you are permitting to put events to
1377
1718
  # your default event bus. Specify "*" to permit any account to put
1378
1719
  # events to your default event bus.
@@ -1384,7 +1725,7 @@ module Aws::CloudWatchEvents
1384
1725
  # with an account field do not match any events sent from other
1385
1726
  # accounts.
1386
1727
  #
1387
- # @option params [required, String] :statement_id
1728
+ # @option params [String] :statement_id
1388
1729
  # An identifier string for the external account that you are granting
1389
1730
  # permissions to. If you later want to revoke the permission for this
1390
1731
  # external account, specify this `StatementId` when you run
@@ -1407,20 +1748,26 @@ module Aws::CloudWatchEvents
1407
1748
  #
1408
1749
  # [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html
1409
1750
  #
1751
+ # @option params [String] :policy
1752
+ # A JSON string that describes the permission policy statement. You can
1753
+ # include a `Policy` parameter in the request instead of using the
1754
+ # `StatementId`, `Action`, `Principal`, or `Condition` parameters.
1755
+ #
1410
1756
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1411
1757
  #
1412
1758
  # @example Request syntax with placeholder values
1413
1759
  #
1414
1760
  # resp = client.put_permission({
1415
1761
  # event_bus_name: "NonPartnerEventBusName",
1416
- # action: "Action", # required
1417
- # principal: "Principal", # required
1418
- # statement_id: "StatementId", # required
1762
+ # action: "Action",
1763
+ # principal: "Principal",
1764
+ # statement_id: "StatementId",
1419
1765
  # condition: {
1420
1766
  # type: "String", # required
1421
1767
  # key: "String", # required
1422
1768
  # value: "String", # required
1423
1769
  # },
1770
+ # policy: "String",
1424
1771
  # })
1425
1772
  #
1426
1773
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutPermission AWS API Documentation
@@ -1526,8 +1873,8 @@ module Aws::CloudWatchEvents
1526
1873
  # The list of key-value pairs to associate with the rule.
1527
1874
  #
1528
1875
  # @option params [String] :event_bus_name
1529
- # The event bus to associate with this rule. If you omit this, the
1530
- # default event bus is used.
1876
+ # The name or ARN of the event bus to associate with this rule. If you
1877
+ # omit this, the default event bus is used.
1531
1878
  #
1532
1879
  # @return [Types::PutRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1533
1880
  #
@@ -1548,7 +1895,7 @@ module Aws::CloudWatchEvents
1548
1895
  # value: "TagValue", # required
1549
1896
  # },
1550
1897
  # ],
1551
- # event_bus_name: "EventBusName",
1898
+ # event_bus_name: "EventBusNameOrArn",
1552
1899
  # })
1553
1900
  #
1554
1901
  # @example Response structure
@@ -1694,8 +2041,8 @@ module Aws::CloudWatchEvents
1694
2041
  # The name of the rule.
1695
2042
  #
1696
2043
  # @option params [String] :event_bus_name
1697
- # The name of the event bus associated with the rule. If you omit this,
1698
- # the default event bus is used.
2044
+ # The name or ARN of the event bus associated with the rule. If you omit
2045
+ # this, the default event bus is used.
1699
2046
  #
1700
2047
  # @option params [required, Array<Types::Target>] :targets
1701
2048
  # The targets to update or add to the rule.
@@ -1709,7 +2056,7 @@ module Aws::CloudWatchEvents
1709
2056
  #
1710
2057
  # resp = client.put_targets({
1711
2058
  # rule: "RuleName", # required
1712
- # event_bus_name: "EventBusName",
2059
+ # event_bus_name: "EventBusNameOrArn",
1713
2060
  # targets: [ # required
1714
2061
  # {
1715
2062
  # id: "TargetId", # required
@@ -1778,6 +2125,13 @@ module Aws::CloudWatchEvents
1778
2125
  # statement_name: "StatementName",
1779
2126
  # with_event: false,
1780
2127
  # },
2128
+ # dead_letter_config: {
2129
+ # arn: "ResourceArn",
2130
+ # },
2131
+ # retry_policy: {
2132
+ # maximum_retry_attempts: 1,
2133
+ # maximum_event_age_in_seconds: 1,
2134
+ # },
1781
2135
  # },
1782
2136
  # ],
1783
2137
  # })
@@ -1805,10 +2159,13 @@ module Aws::CloudWatchEvents
1805
2159
  # granted it permission with `PutPermission`. You can find the
1806
2160
  # `StatementId` by using DescribeEventBus.
1807
2161
  #
1808
- # @option params [required, String] :statement_id
2162
+ # @option params [String] :statement_id
1809
2163
  # The statement ID corresponding to the account that is no longer
1810
2164
  # allowed to put events to the default event bus.
1811
2165
  #
2166
+ # @option params [Boolean] :remove_all_permissions
2167
+ # Specifies whether to remove all permissions.
2168
+ #
1812
2169
  # @option params [String] :event_bus_name
1813
2170
  # The name of the event bus to revoke permissions for. If you omit this,
1814
2171
  # the default event bus is used.
@@ -1818,7 +2175,8 @@ module Aws::CloudWatchEvents
1818
2175
  # @example Request syntax with placeholder values
1819
2176
  #
1820
2177
  # resp = client.remove_permission({
1821
- # statement_id: "StatementId", # required
2178
+ # statement_id: "StatementId",
2179
+ # remove_all_permissions: false,
1822
2180
  # event_bus_name: "NonPartnerEventBusName",
1823
2181
  # })
1824
2182
  #
@@ -1847,7 +2205,8 @@ module Aws::CloudWatchEvents
1847
2205
  # The name of the rule.
1848
2206
  #
1849
2207
  # @option params [String] :event_bus_name
1850
- # The name of the event bus associated with the rule.
2208
+ # The name or ARN of the event bus associated with the rule. If you omit
2209
+ # this, the default event bus is used.
1851
2210
  #
1852
2211
  # @option params [required, Array<String>] :ids
1853
2212
  # The IDs of the targets to remove from the rule.
@@ -1868,7 +2227,7 @@ module Aws::CloudWatchEvents
1868
2227
  #
1869
2228
  # resp = client.remove_targets({
1870
2229
  # rule: "RuleName", # required
1871
- # event_bus_name: "EventBusName",
2230
+ # event_bus_name: "EventBusNameOrArn",
1872
2231
  # ids: ["TargetId"], # required
1873
2232
  # force: false,
1874
2233
  # })
@@ -1890,6 +2249,75 @@ module Aws::CloudWatchEvents
1890
2249
  req.send_request(options)
1891
2250
  end
1892
2251
 
2252
+ # Starts the specified replay. Events are not necessarily replayed in
2253
+ # the exact same order that they were added to the archive. A replay
2254
+ # processes events to replay based on the time in the event, and replays
2255
+ # them using 1 minute intervals. If you specify an `EventStartTime` and
2256
+ # an `EventEndTime` that covers a 20 minute time range, the events are
2257
+ # replayed from the first minute of that 20 minute range first. Then the
2258
+ # events from the second minute are replayed. You can use
2259
+ # `DescribeReplay` to determine the progress of a replay. The value
2260
+ # returned for `EventLastReplayedTime` indicates the time within the
2261
+ # specified time range associated with the last event replayed.
2262
+ #
2263
+ # @option params [required, String] :replay_name
2264
+ # The name of the replay to start.
2265
+ #
2266
+ # @option params [String] :description
2267
+ # A description for the replay to start.
2268
+ #
2269
+ # @option params [required, String] :event_source_arn
2270
+ # The ARN of the archive to replay events from.
2271
+ #
2272
+ # @option params [required, Time,DateTime,Date,Integer,String] :event_start_time
2273
+ # A time stamp for the time to start replaying events. Only events that
2274
+ # occurred between the `EventStartTime` and `EventEndTime` are replayed.
2275
+ #
2276
+ # @option params [required, Time,DateTime,Date,Integer,String] :event_end_time
2277
+ # A time stamp for the time to stop replaying events. Only events that
2278
+ # occurred between the `EventStartTime` and `EventEndTime` are replayed.
2279
+ #
2280
+ # @option params [required, Types::ReplayDestination] :destination
2281
+ # A `ReplayDestination` object that includes details about the
2282
+ # destination for the replay.
2283
+ #
2284
+ # @return [Types::StartReplayResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2285
+ #
2286
+ # * {Types::StartReplayResponse#replay_arn #replay_arn} => String
2287
+ # * {Types::StartReplayResponse#state #state} => String
2288
+ # * {Types::StartReplayResponse#state_reason #state_reason} => String
2289
+ # * {Types::StartReplayResponse#replay_start_time #replay_start_time} => Time
2290
+ #
2291
+ # @example Request syntax with placeholder values
2292
+ #
2293
+ # resp = client.start_replay({
2294
+ # replay_name: "ReplayName", # required
2295
+ # description: "ReplayDescription",
2296
+ # event_source_arn: "Arn", # required
2297
+ # event_start_time: Time.now, # required
2298
+ # event_end_time: Time.now, # required
2299
+ # destination: { # required
2300
+ # arn: "Arn", # required
2301
+ # filter_arns: ["Arn"],
2302
+ # },
2303
+ # })
2304
+ #
2305
+ # @example Response structure
2306
+ #
2307
+ # resp.replay_arn #=> String
2308
+ # resp.state #=> String, one of "STARTING", "RUNNING", "CANCELLING", "COMPLETED", "CANCELLED", "FAILED"
2309
+ # resp.state_reason #=> String
2310
+ # resp.replay_start_time #=> Time
2311
+ #
2312
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/StartReplay AWS API Documentation
2313
+ #
2314
+ # @overload start_replay(params = {})
2315
+ # @param [Hash] params ({})
2316
+ def start_replay(params = {}, options = {})
2317
+ req = build_request(:start_replay, params)
2318
+ req.send_request(options)
2319
+ end
2320
+
1893
2321
  # Assigns one or more tags (key-value pairs) to the specified
1894
2322
  # EventBridge resource. Tags can help you organize and categorize your
1895
2323
  # resources. You can also use them to scope user permissions by granting
@@ -2007,6 +2435,52 @@ module Aws::CloudWatchEvents
2007
2435
  req.send_request(options)
2008
2436
  end
2009
2437
 
2438
+ # Updates the specified archive.
2439
+ #
2440
+ # @option params [required, String] :archive_name
2441
+ # The name of the archive to update.
2442
+ #
2443
+ # @option params [String] :description
2444
+ # The description for the archive.
2445
+ #
2446
+ # @option params [String] :event_pattern
2447
+ # The event pattern to use to filter events sent to the archive.
2448
+ #
2449
+ # @option params [Integer] :retention_days
2450
+ # The number of days to retain events in the archive.
2451
+ #
2452
+ # @return [Types::UpdateArchiveResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2453
+ #
2454
+ # * {Types::UpdateArchiveResponse#archive_arn #archive_arn} => String
2455
+ # * {Types::UpdateArchiveResponse#state #state} => String
2456
+ # * {Types::UpdateArchiveResponse#state_reason #state_reason} => String
2457
+ # * {Types::UpdateArchiveResponse#creation_time #creation_time} => Time
2458
+ #
2459
+ # @example Request syntax with placeholder values
2460
+ #
2461
+ # resp = client.update_archive({
2462
+ # archive_name: "ArchiveName", # required
2463
+ # description: "ArchiveDescription",
2464
+ # event_pattern: "EventPattern",
2465
+ # retention_days: 1,
2466
+ # })
2467
+ #
2468
+ # @example Response structure
2469
+ #
2470
+ # resp.archive_arn #=> String
2471
+ # resp.state #=> String, one of "ENABLED", "DISABLED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
2472
+ # resp.state_reason #=> String
2473
+ # resp.creation_time #=> Time
2474
+ #
2475
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateArchive AWS API Documentation
2476
+ #
2477
+ # @overload update_archive(params = {})
2478
+ # @param [Hash] params ({})
2479
+ def update_archive(params = {}, options = {})
2480
+ req = build_request(:update_archive, params)
2481
+ req.send_request(options)
2482
+ end
2483
+
2010
2484
  # @!endgroup
2011
2485
 
2012
2486
  # @param params ({})
@@ -2020,7 +2494,7 @@ module Aws::CloudWatchEvents
2020
2494
  params: params,
2021
2495
  config: config)
2022
2496
  context[:gem_name] = 'aws-sdk-cloudwatchevents'
2023
- context[:gem_version] = '1.36.0'
2497
+ context[:gem_version] = '1.41.0'
2024
2498
  Seahorse::Client::Request.new(handlers, context)
2025
2499
  end
2026
2500