aws-sdk-eventbridge 1.15.0 → 1.20.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-eventbridge.rb +1 -1
- data/lib/aws-sdk-eventbridge/client.rb +540 -45
- data/lib/aws-sdk-eventbridge/client_api.rb +320 -16
- data/lib/aws-sdk-eventbridge/errors.rb +11 -0
- data/lib/aws-sdk-eventbridge/types.rb +922 -52
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 947917368c376790c98610f36254a1e2fec0b23dad8217d41e191539b0e96fab
|
4
|
+
data.tar.gz: 9cae525ce35aba3f7ee34559dcb3e11303d18c73ae6cf7141be2e73f4782239b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2a067cbdb2658dcfcf80c6a72b07aa53ae7454ecaaeaa01e13feaad24b6cd9f5a77756297fc52448e98046ee40485f841e434b261cc761d41250eca86e7891ae
|
7
|
+
data.tar.gz: 218bbc20086f41d34f3f0ab2707473a2c5337cfdb185fd3e90876155f4a7e76d4b495c6bca6646a2feb1411419175f5b92c90ebee147a4e7903e90b27d83bd6e
|
data/lib/aws-sdk-eventbridge.rb
CHANGED
@@ -361,6 +361,94 @@ module Aws::EventBridge
|
|
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/eventbridge-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/eventbridge-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::EventBridge
|
|
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/eventbridge-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::EventBridge
|
|
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
|
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::EventBridge
|
|
596
706
|
#
|
597
707
|
# resp = client.delete_rule({
|
598
708
|
# name: "RuleName", # required
|
599
|
-
# event_bus_name: "
|
709
|
+
# event_bus_name: "EventBusNameOrArn",
|
600
710
|
# force: false,
|
601
711
|
# })
|
602
712
|
#
|
@@ -609,6 +719,54 @@ module Aws::EventBridge
|
|
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/eventbridge-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::EventBridge
|
|
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
|
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::EventBridge
|
|
633
791
|
# @example Request syntax with placeholder values
|
634
792
|
#
|
635
793
|
# resp = client.describe_event_bus({
|
636
|
-
# name: "
|
794
|
+
# name: "EventBusNameOrArn",
|
637
795
|
# })
|
638
796
|
#
|
639
797
|
# @example Response structure
|
@@ -723,6 +881,67 @@ module Aws::EventBridge
|
|
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/eventbridge-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::EventBridge
|
|
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
|
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::EventBridge
|
|
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: "
|
974
|
+
# event_bus_name: "EventBusNameOrArn",
|
755
975
|
# })
|
756
976
|
#
|
757
977
|
# @example Response structure
|
@@ -765,6 +985,7 @@ module Aws::EventBridge
|
|
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/eventbridge-2015-10-07/DescribeRule AWS API Documentation
|
770
991
|
#
|
@@ -786,8 +1007,8 @@ module Aws::EventBridge
|
|
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
|
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::EventBridge
|
|
795
1016
|
#
|
796
1017
|
# resp = client.disable_rule({
|
797
1018
|
# name: "RuleName", # required
|
798
|
-
# event_bus_name: "
|
1019
|
+
# event_bus_name: "EventBusNameOrArn",
|
799
1020
|
# })
|
800
1021
|
#
|
801
1022
|
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DisableRule AWS API Documentation
|
@@ -818,8 +1039,8 @@ module Aws::EventBridge
|
|
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
|
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::EventBridge
|
|
827
1048
|
#
|
828
1049
|
# resp = client.enable_rule({
|
829
1050
|
# name: "RuleName", # required
|
830
|
-
# event_bus_name: "
|
1051
|
+
# event_bus_name: "EventBusNameOrArn",
|
831
1052
|
# })
|
832
1053
|
#
|
833
1054
|
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/EnableRule AWS API Documentation
|
@@ -839,6 +1060,64 @@ module Aws::EventBridge
|
|
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/eventbridge-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::EventBridge
|
|
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/eventbridge-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::EventBridge
|
|
1037
1375
|
# The Amazon Resource Name (ARN) of the target resource.
|
1038
1376
|
#
|
1039
1377
|
# @option params [String] :event_bus_name
|
1040
|
-
#
|
1041
|
-
#
|
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::EventBridge
|
|
1056
1394
|
#
|
1057
1395
|
# resp = client.list_rule_names_by_target({
|
1058
1396
|
# target_arn: "TargetArn", # required
|
1059
|
-
# event_bus_name: "
|
1397
|
+
# event_bus_name: "EventBusNameOrArn",
|
1060
1398
|
# next_token: "NextToken",
|
1061
1399
|
# limit: 1,
|
1062
1400
|
# })
|
@@ -1086,8 +1424,8 @@ module Aws::EventBridge
|
|
1086
1424
|
# The prefix matching the rule name.
|
1087
1425
|
#
|
1088
1426
|
# @option params [String] :event_bus_name
|
1089
|
-
#
|
1090
|
-
#
|
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::EventBridge
|
|
1105
1443
|
#
|
1106
1444
|
# resp = client.list_rules({
|
1107
1445
|
# name_prefix: "RuleName",
|
1108
|
-
# event_bus_name: "
|
1446
|
+
# event_bus_name: "EventBusNameOrArn",
|
1109
1447
|
# next_token: "NextToken",
|
1110
1448
|
# limit: 1,
|
1111
1449
|
# })
|
@@ -1170,8 +1508,8 @@ module Aws::EventBridge
|
|
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
|
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::EventBridge
|
|
1189
1527
|
#
|
1190
1528
|
# resp = client.list_targets_by_rule({
|
1191
1529
|
# rule: "RuleName", # required
|
1192
|
-
# event_bus_name: "
|
1530
|
+
# event_bus_name: "EventBusNameOrArn",
|
1193
1531
|
# next_token: "NextToken",
|
1194
1532
|
# limit: 1,
|
1195
1533
|
# })
|
@@ -1237,6 +1575,9 @@ module Aws::EventBridge
|
|
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/eventbridge-2015-10-07/ListTargetsByRule AWS API Documentation
|
@@ -1271,7 +1612,8 @@ module Aws::EventBridge
|
|
1271
1612
|
# resources: ["EventResource"],
|
1272
1613
|
# detail_type: "String",
|
1273
1614
|
# detail: "String",
|
1274
|
-
# event_bus_name: "
|
1615
|
+
# event_bus_name: "NonPartnerEventBusNameOrArn",
|
1616
|
+
# trace_header: "TraceHeader",
|
1275
1617
|
# },
|
1276
1618
|
# ],
|
1277
1619
|
# })
|
@@ -1365,14 +1707,14 @@ module Aws::EventBridge
|
|
1365
1707
|
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
|
1366
1708
|
#
|
1367
1709
|
# @option params [String] :event_bus_name
|
1368
|
-
# The event bus associated with the rule. If you omit this,
|
1369
|
-
# event bus is used.
|
1710
|
+
# The name of the event bus associated with the rule. If you omit this,
|
1711
|
+
# the default event bus is used.
|
1370
1712
|
#
|
1371
|
-
# @option params [
|
1713
|
+
# @option params [String] :action
|
1372
1714
|
# The action that you are enabling the other account to perform.
|
1373
1715
|
# Currently, this must be `events:PutEvents`.
|
1374
1716
|
#
|
1375
|
-
# @option params [
|
1717
|
+
# @option params [String] :principal
|
1376
1718
|
# The 12-digit AWS account ID that you are permitting to put events to
|
1377
1719
|
# your default event bus. Specify "*" to permit any account to put
|
1378
1720
|
# events to your default event bus.
|
@@ -1384,7 +1726,7 @@ module Aws::EventBridge
|
|
1384
1726
|
# with an account field do not match any events sent from other
|
1385
1727
|
# accounts.
|
1386
1728
|
#
|
1387
|
-
# @option params [
|
1729
|
+
# @option params [String] :statement_id
|
1388
1730
|
# An identifier string for the external account that you are granting
|
1389
1731
|
# permissions to. If you later want to revoke the permission for this
|
1390
1732
|
# external account, specify this `StatementId` when you run
|
@@ -1407,20 +1749,26 @@ module Aws::EventBridge
|
|
1407
1749
|
#
|
1408
1750
|
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html
|
1409
1751
|
#
|
1752
|
+
# @option params [String] :policy
|
1753
|
+
# A JSON string that describes the permission policy statement. You can
|
1754
|
+
# include a `Policy` parameter in the request instead of using the
|
1755
|
+
# `StatementId`, `Action`, `Principal`, or `Condition` parameters.
|
1756
|
+
#
|
1410
1757
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1411
1758
|
#
|
1412
1759
|
# @example Request syntax with placeholder values
|
1413
1760
|
#
|
1414
1761
|
# resp = client.put_permission({
|
1415
1762
|
# event_bus_name: "NonPartnerEventBusName",
|
1416
|
-
# action: "Action",
|
1417
|
-
# principal: "Principal",
|
1418
|
-
# statement_id: "StatementId",
|
1763
|
+
# action: "Action",
|
1764
|
+
# principal: "Principal",
|
1765
|
+
# statement_id: "StatementId",
|
1419
1766
|
# condition: {
|
1420
1767
|
# type: "String", # required
|
1421
1768
|
# key: "String", # required
|
1422
1769
|
# value: "String", # required
|
1423
1770
|
# },
|
1771
|
+
# policy: "String",
|
1424
1772
|
# })
|
1425
1773
|
#
|
1426
1774
|
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PutPermission AWS API Documentation
|
@@ -1526,8 +1874,8 @@ module Aws::EventBridge
|
|
1526
1874
|
# The list of key-value pairs to associate with the rule.
|
1527
1875
|
#
|
1528
1876
|
# @option params [String] :event_bus_name
|
1529
|
-
# The event bus to associate with this rule. If you
|
1530
|
-
# default event bus is used.
|
1877
|
+
# The name or ARN of the event bus to associate with this rule. If you
|
1878
|
+
# omit this, the default event bus is used.
|
1531
1879
|
#
|
1532
1880
|
# @return [Types::PutRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1533
1881
|
#
|
@@ -1548,7 +1896,7 @@ module Aws::EventBridge
|
|
1548
1896
|
# value: "TagValue", # required
|
1549
1897
|
# },
|
1550
1898
|
# ],
|
1551
|
-
# event_bus_name: "
|
1899
|
+
# event_bus_name: "EventBusNameOrArn",
|
1552
1900
|
# })
|
1553
1901
|
#
|
1554
1902
|
# @example Response structure
|
@@ -1694,8 +2042,8 @@ module Aws::EventBridge
|
|
1694
2042
|
# The name of the rule.
|
1695
2043
|
#
|
1696
2044
|
# @option params [String] :event_bus_name
|
1697
|
-
# The name of the event bus associated with the rule. If you omit
|
1698
|
-
# the default event bus is used.
|
2045
|
+
# The name or ARN of the event bus associated with the rule. If you omit
|
2046
|
+
# this, the default event bus is used.
|
1699
2047
|
#
|
1700
2048
|
# @option params [required, Array<Types::Target>] :targets
|
1701
2049
|
# The targets to update or add to the rule.
|
@@ -1709,7 +2057,7 @@ module Aws::EventBridge
|
|
1709
2057
|
#
|
1710
2058
|
# resp = client.put_targets({
|
1711
2059
|
# rule: "RuleName", # required
|
1712
|
-
# event_bus_name: "
|
2060
|
+
# event_bus_name: "EventBusNameOrArn",
|
1713
2061
|
# targets: [ # required
|
1714
2062
|
# {
|
1715
2063
|
# id: "TargetId", # required
|
@@ -1778,6 +2126,13 @@ module Aws::EventBridge
|
|
1778
2126
|
# statement_name: "StatementName",
|
1779
2127
|
# with_event: false,
|
1780
2128
|
# },
|
2129
|
+
# dead_letter_config: {
|
2130
|
+
# arn: "ResourceArn",
|
2131
|
+
# },
|
2132
|
+
# retry_policy: {
|
2133
|
+
# maximum_retry_attempts: 1,
|
2134
|
+
# maximum_event_age_in_seconds: 1,
|
2135
|
+
# },
|
1781
2136
|
# },
|
1782
2137
|
# ],
|
1783
2138
|
# })
|
@@ -1805,10 +2160,13 @@ module Aws::EventBridge
|
|
1805
2160
|
# granted it permission with `PutPermission`. You can find the
|
1806
2161
|
# `StatementId` by using DescribeEventBus.
|
1807
2162
|
#
|
1808
|
-
# @option params [
|
2163
|
+
# @option params [String] :statement_id
|
1809
2164
|
# The statement ID corresponding to the account that is no longer
|
1810
2165
|
# allowed to put events to the default event bus.
|
1811
2166
|
#
|
2167
|
+
# @option params [Boolean] :remove_all_permissions
|
2168
|
+
# Specifies whether to remove all permissions.
|
2169
|
+
#
|
1812
2170
|
# @option params [String] :event_bus_name
|
1813
2171
|
# The name of the event bus to revoke permissions for. If you omit this,
|
1814
2172
|
# the default event bus is used.
|
@@ -1818,7 +2176,8 @@ module Aws::EventBridge
|
|
1818
2176
|
# @example Request syntax with placeholder values
|
1819
2177
|
#
|
1820
2178
|
# resp = client.remove_permission({
|
1821
|
-
# statement_id: "StatementId",
|
2179
|
+
# statement_id: "StatementId",
|
2180
|
+
# remove_all_permissions: false,
|
1822
2181
|
# event_bus_name: "NonPartnerEventBusName",
|
1823
2182
|
# })
|
1824
2183
|
#
|
@@ -1847,7 +2206,8 @@ module Aws::EventBridge
|
|
1847
2206
|
# The name of the rule.
|
1848
2207
|
#
|
1849
2208
|
# @option params [String] :event_bus_name
|
1850
|
-
# The name of the event bus associated with the rule.
|
2209
|
+
# The name or ARN of the event bus associated with the rule. If you omit
|
2210
|
+
# this, the default event bus is used.
|
1851
2211
|
#
|
1852
2212
|
# @option params [required, Array<String>] :ids
|
1853
2213
|
# The IDs of the targets to remove from the rule.
|
@@ -1868,7 +2228,7 @@ module Aws::EventBridge
|
|
1868
2228
|
#
|
1869
2229
|
# resp = client.remove_targets({
|
1870
2230
|
# rule: "RuleName", # required
|
1871
|
-
# event_bus_name: "
|
2231
|
+
# event_bus_name: "EventBusNameOrArn",
|
1872
2232
|
# ids: ["TargetId"], # required
|
1873
2233
|
# force: false,
|
1874
2234
|
# })
|
@@ -1890,6 +2250,75 @@ module Aws::EventBridge
|
|
1890
2250
|
req.send_request(options)
|
1891
2251
|
end
|
1892
2252
|
|
2253
|
+
# Starts the specified replay. Events are not necessarily replayed in
|
2254
|
+
# the exact same order that they were added to the archive. A replay
|
2255
|
+
# processes events to replay based on the time in the event, and replays
|
2256
|
+
# them using 1 minute intervals. If you specify an `EventStartTime` and
|
2257
|
+
# an `EventEndTime` that covers a 20 minute time range, the events are
|
2258
|
+
# replayed from the first minute of that 20 minute range first. Then the
|
2259
|
+
# events from the second minute are replayed. You can use
|
2260
|
+
# `DescribeReplay` to determine the progress of a replay. The value
|
2261
|
+
# returned for `EventLastReplayedTime` indicates the time within the
|
2262
|
+
# specified time range associated with the last event replayed.
|
2263
|
+
#
|
2264
|
+
# @option params [required, String] :replay_name
|
2265
|
+
# The name of the replay to start.
|
2266
|
+
#
|
2267
|
+
# @option params [String] :description
|
2268
|
+
# A description for the replay to start.
|
2269
|
+
#
|
2270
|
+
# @option params [required, String] :event_source_arn
|
2271
|
+
# The ARN of the archive to replay events from.
|
2272
|
+
#
|
2273
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :event_start_time
|
2274
|
+
# A time stamp for the time to start replaying events. Only events that
|
2275
|
+
# occurred between the `EventStartTime` and `EventEndTime` are replayed.
|
2276
|
+
#
|
2277
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :event_end_time
|
2278
|
+
# A time stamp for the time to stop replaying events. Only events that
|
2279
|
+
# occurred between the `EventStartTime` and `EventEndTime` are replayed.
|
2280
|
+
#
|
2281
|
+
# @option params [required, Types::ReplayDestination] :destination
|
2282
|
+
# A `ReplayDestination` object that includes details about the
|
2283
|
+
# destination for the replay.
|
2284
|
+
#
|
2285
|
+
# @return [Types::StartReplayResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2286
|
+
#
|
2287
|
+
# * {Types::StartReplayResponse#replay_arn #replay_arn} => String
|
2288
|
+
# * {Types::StartReplayResponse#state #state} => String
|
2289
|
+
# * {Types::StartReplayResponse#state_reason #state_reason} => String
|
2290
|
+
# * {Types::StartReplayResponse#replay_start_time #replay_start_time} => Time
|
2291
|
+
#
|
2292
|
+
# @example Request syntax with placeholder values
|
2293
|
+
#
|
2294
|
+
# resp = client.start_replay({
|
2295
|
+
# replay_name: "ReplayName", # required
|
2296
|
+
# description: "ReplayDescription",
|
2297
|
+
# event_source_arn: "Arn", # required
|
2298
|
+
# event_start_time: Time.now, # required
|
2299
|
+
# event_end_time: Time.now, # required
|
2300
|
+
# destination: { # required
|
2301
|
+
# arn: "Arn", # required
|
2302
|
+
# filter_arns: ["Arn"],
|
2303
|
+
# },
|
2304
|
+
# })
|
2305
|
+
#
|
2306
|
+
# @example Response structure
|
2307
|
+
#
|
2308
|
+
# resp.replay_arn #=> String
|
2309
|
+
# resp.state #=> String, one of "STARTING", "RUNNING", "CANCELLING", "COMPLETED", "CANCELLED", "FAILED"
|
2310
|
+
# resp.state_reason #=> String
|
2311
|
+
# resp.replay_start_time #=> Time
|
2312
|
+
#
|
2313
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/StartReplay AWS API Documentation
|
2314
|
+
#
|
2315
|
+
# @overload start_replay(params = {})
|
2316
|
+
# @param [Hash] params ({})
|
2317
|
+
def start_replay(params = {}, options = {})
|
2318
|
+
req = build_request(:start_replay, params)
|
2319
|
+
req.send_request(options)
|
2320
|
+
end
|
2321
|
+
|
1893
2322
|
# Assigns one or more tags (key-value pairs) to the specified
|
1894
2323
|
# EventBridge resource. Tags can help you organize and categorize your
|
1895
2324
|
# resources. You can also use them to scope user permissions by granting
|
@@ -1953,7 +2382,27 @@ module Aws::EventBridge
|
|
1953
2382
|
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
|
1954
2383
|
#
|
1955
2384
|
# @option params [required, String] :event
|
1956
|
-
# The event, in JSON format, to test against the event pattern.
|
2385
|
+
# The event, in JSON format, to test against the event pattern. The JSON
|
2386
|
+
# must follow the format specified in [AWS Events][1], and the following
|
2387
|
+
# fields are mandatory:
|
2388
|
+
#
|
2389
|
+
# * `id`
|
2390
|
+
#
|
2391
|
+
# * `account`
|
2392
|
+
#
|
2393
|
+
# * `source`
|
2394
|
+
#
|
2395
|
+
# * `time`
|
2396
|
+
#
|
2397
|
+
# * `region`
|
2398
|
+
#
|
2399
|
+
# * `resources`
|
2400
|
+
#
|
2401
|
+
# * `detail-type`
|
2402
|
+
#
|
2403
|
+
#
|
2404
|
+
#
|
2405
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html
|
1957
2406
|
#
|
1958
2407
|
# @return [Types::TestEventPatternResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1959
2408
|
#
|
@@ -2007,6 +2456,52 @@ module Aws::EventBridge
|
|
2007
2456
|
req.send_request(options)
|
2008
2457
|
end
|
2009
2458
|
|
2459
|
+
# Updates the specified archive.
|
2460
|
+
#
|
2461
|
+
# @option params [required, String] :archive_name
|
2462
|
+
# The name of the archive to update.
|
2463
|
+
#
|
2464
|
+
# @option params [String] :description
|
2465
|
+
# The description for the archive.
|
2466
|
+
#
|
2467
|
+
# @option params [String] :event_pattern
|
2468
|
+
# The event pattern to use to filter events sent to the archive.
|
2469
|
+
#
|
2470
|
+
# @option params [Integer] :retention_days
|
2471
|
+
# The number of days to retain events in the archive.
|
2472
|
+
#
|
2473
|
+
# @return [Types::UpdateArchiveResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2474
|
+
#
|
2475
|
+
# * {Types::UpdateArchiveResponse#archive_arn #archive_arn} => String
|
2476
|
+
# * {Types::UpdateArchiveResponse#state #state} => String
|
2477
|
+
# * {Types::UpdateArchiveResponse#state_reason #state_reason} => String
|
2478
|
+
# * {Types::UpdateArchiveResponse#creation_time #creation_time} => Time
|
2479
|
+
#
|
2480
|
+
# @example Request syntax with placeholder values
|
2481
|
+
#
|
2482
|
+
# resp = client.update_archive({
|
2483
|
+
# archive_name: "ArchiveName", # required
|
2484
|
+
# description: "ArchiveDescription",
|
2485
|
+
# event_pattern: "EventPattern",
|
2486
|
+
# retention_days: 1,
|
2487
|
+
# })
|
2488
|
+
#
|
2489
|
+
# @example Response structure
|
2490
|
+
#
|
2491
|
+
# resp.archive_arn #=> String
|
2492
|
+
# resp.state #=> String, one of "ENABLED", "DISABLED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
|
2493
|
+
# resp.state_reason #=> String
|
2494
|
+
# resp.creation_time #=> Time
|
2495
|
+
#
|
2496
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateArchive AWS API Documentation
|
2497
|
+
#
|
2498
|
+
# @overload update_archive(params = {})
|
2499
|
+
# @param [Hash] params ({})
|
2500
|
+
def update_archive(params = {}, options = {})
|
2501
|
+
req = build_request(:update_archive, params)
|
2502
|
+
req.send_request(options)
|
2503
|
+
end
|
2504
|
+
|
2010
2505
|
# @!endgroup
|
2011
2506
|
|
2012
2507
|
# @param params ({})
|
@@ -2020,7 +2515,7 @@ module Aws::EventBridge
|
|
2020
2515
|
params: params,
|
2021
2516
|
config: config)
|
2022
2517
|
context[:gem_name] = 'aws-sdk-eventbridge'
|
2023
|
-
context[:gem_version] = '1.
|
2518
|
+
context[:gem_version] = '1.20.0'
|
2024
2519
|
Seahorse::Client::Request.new(handlers, context)
|
2025
2520
|
end
|
2026
2521
|
|