aws-sdk-notifications 1.0.0 → 1.2.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/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-notifications/client.rb +826 -113
- data/lib/aws-sdk-notifications/client_api.rb +521 -0
- data/lib/aws-sdk-notifications/types.rb +1632 -390
- data/lib/aws-sdk-notifications.rb +1 -1
- data/sig/client.rbs +171 -0
- data/sig/resource.rbs +2 -0
- data/sig/types.rbs +299 -0
- metadata +4 -4
@@ -257,11 +257,34 @@ module Aws::Notifications
|
|
257
257
|
# Used when loading credentials from the shared credentials file
|
258
258
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
259
259
|
#
|
260
|
+
# @option options [String] :request_checksum_calculation ("when_supported")
|
261
|
+
# Determines when a checksum will be calculated for request payloads. Values are:
|
262
|
+
#
|
263
|
+
# * `when_supported` - (default) When set, a checksum will be
|
264
|
+
# calculated for all request payloads of operations modeled with the
|
265
|
+
# `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
|
266
|
+
# `requestAlgorithmMember` is modeled.
|
267
|
+
# * `when_required` - When set, a checksum will only be calculated for
|
268
|
+
# request payloads of operations modeled with the `httpChecksum` trait where
|
269
|
+
# `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
|
270
|
+
# is modeled and supplied.
|
271
|
+
#
|
260
272
|
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
261
273
|
# The minimum size in bytes that triggers compression for request
|
262
274
|
# bodies. The value must be non-negative integer value between 0
|
263
275
|
# and 10485780 bytes inclusive.
|
264
276
|
#
|
277
|
+
# @option options [String] :response_checksum_validation ("when_supported")
|
278
|
+
# Determines when checksum validation will be performed on response payloads. Values are:
|
279
|
+
#
|
280
|
+
# * `when_supported` - (default) When set, checksum validation is performed on all
|
281
|
+
# response payloads of operations modeled with the `httpChecksum` trait where
|
282
|
+
# `responseAlgorithms` is modeled, except when no modeled checksum algorithms
|
283
|
+
# are supported.
|
284
|
+
# * `when_required` - When set, checksum validation is not performed on
|
285
|
+
# response payloads of operations unless the checksum algorithm is supported and
|
286
|
+
# the `requestValidationModeMember` member is set to `ENABLED`.
|
287
|
+
#
|
265
288
|
# @option options [Proc] :retry_backoff
|
266
289
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
267
290
|
# This option is only used in the `legacy` retry mode.
|
@@ -448,8 +471,8 @@ module Aws::Notifications
|
|
448
471
|
# @!group API Operations
|
449
472
|
|
450
473
|
# Associates a delivery [Channel][1] with a particular
|
451
|
-
# NotificationConfiguration
|
452
|
-
#
|
474
|
+
# `NotificationConfiguration`. Supported Channels include Chatbot, the
|
475
|
+
# Console Mobile Application, and emails (notifications-contacts).
|
453
476
|
#
|
454
477
|
#
|
455
478
|
#
|
@@ -457,13 +480,13 @@ module Aws::Notifications
|
|
457
480
|
#
|
458
481
|
# @option params [required, String] :arn
|
459
482
|
# The Amazon Resource Name (ARN) of the Channel to associate with the
|
460
|
-
# NotificationConfiguration
|
483
|
+
# `NotificationConfiguration`.
|
461
484
|
#
|
462
|
-
# Supported ARNs include
|
463
|
-
#
|
485
|
+
# Supported ARNs include Chatbot, the Console Mobile Application, and
|
486
|
+
# notifications-contacts.
|
464
487
|
#
|
465
488
|
# @option params [required, String] :notification_configuration_arn
|
466
|
-
# The ARN of the NotificationConfiguration to associate with the
|
489
|
+
# The ARN of the `NotificationConfiguration` to associate with the
|
467
490
|
# Channel.
|
468
491
|
#
|
469
492
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -484,24 +507,91 @@ module Aws::Notifications
|
|
484
507
|
req.send_request(options)
|
485
508
|
end
|
486
509
|
|
487
|
-
#
|
488
|
-
#
|
510
|
+
# Associates an Account Contact with a particular
|
511
|
+
# `ManagedNotificationConfiguration`.
|
512
|
+
#
|
513
|
+
# @option params [required, String] :contact_identifier
|
514
|
+
# A unique value of an Account Contact Type to associate with the
|
515
|
+
# `ManagedNotificationConfiguration`.
|
516
|
+
#
|
517
|
+
# @option params [required, String] :managed_notification_configuration_arn
|
518
|
+
# The Amazon Resource Name (ARN) of the
|
519
|
+
# `ManagedNotificationConfiguration` to associate with the Account
|
520
|
+
# Contact.
|
521
|
+
#
|
522
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
523
|
+
#
|
524
|
+
# @example Request syntax with placeholder values
|
525
|
+
#
|
526
|
+
# resp = client.associate_managed_notification_account_contact({
|
527
|
+
# contact_identifier: "ACCOUNT_PRIMARY", # required, accepts ACCOUNT_PRIMARY, ACCOUNT_ALTERNATE_BILLING, ACCOUNT_ALTERNATE_OPERATIONS, ACCOUNT_ALTERNATE_SECURITY
|
528
|
+
# managed_notification_configuration_arn: "ManagedNotificationConfigurationOsArn", # required
|
529
|
+
# })
|
530
|
+
#
|
531
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/AssociateManagedNotificationAccountContact AWS API Documentation
|
532
|
+
#
|
533
|
+
# @overload associate_managed_notification_account_contact(params = {})
|
534
|
+
# @param [Hash] params ({})
|
535
|
+
def associate_managed_notification_account_contact(params = {}, options = {})
|
536
|
+
req = build_request(:associate_managed_notification_account_contact, params)
|
537
|
+
req.send_request(options)
|
538
|
+
end
|
539
|
+
|
540
|
+
# Associates an additional Channel with a particular
|
541
|
+
# `ManagedNotificationConfiguration`.
|
542
|
+
#
|
543
|
+
# Supported Channels include Chatbot, the Console Mobile Application,
|
544
|
+
# and emails (notifications-contacts).
|
545
|
+
#
|
546
|
+
# @option params [required, String] :channel_arn
|
547
|
+
# The Amazon Resource Name (ARN) of the Channel to associate with the
|
548
|
+
# `ManagedNotificationConfiguration`.
|
549
|
+
#
|
550
|
+
# Supported ARNs include Chatbot, the Console Mobile Application, and
|
551
|
+
# email (notifications-contacts).
|
552
|
+
#
|
553
|
+
# @option params [required, String] :managed_notification_configuration_arn
|
554
|
+
# The Amazon Resource Name (ARN) of the
|
555
|
+
# `ManagedNotificationConfiguration` to associate with the additional
|
556
|
+
# Channel.
|
557
|
+
#
|
558
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
559
|
+
#
|
560
|
+
# @example Request syntax with placeholder values
|
561
|
+
#
|
562
|
+
# resp = client.associate_managed_notification_additional_channel({
|
563
|
+
# channel_arn: "ChannelArn", # required
|
564
|
+
# managed_notification_configuration_arn: "ManagedNotificationConfigurationOsArn", # required
|
565
|
+
# })
|
566
|
+
#
|
567
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/AssociateManagedNotificationAdditionalChannel AWS API Documentation
|
568
|
+
#
|
569
|
+
# @overload associate_managed_notification_additional_channel(params = {})
|
570
|
+
# @param [Hash] params ({})
|
571
|
+
def associate_managed_notification_additional_channel(params = {}, options = {})
|
572
|
+
req = build_request(:associate_managed_notification_additional_channel, params)
|
573
|
+
req.send_request(options)
|
574
|
+
end
|
575
|
+
|
576
|
+
# Creates an [ `EventRule` ][1] that is associated with a specified
|
577
|
+
# `NotificationConfiguration`.
|
489
578
|
#
|
490
579
|
#
|
491
580
|
#
|
492
581
|
# [1]: https://docs.aws.amazon.com/notifications/latest/userguide/glossary.html
|
493
582
|
#
|
494
583
|
# @option params [required, String] :notification_configuration_arn
|
495
|
-
# The Amazon Resource Name (ARN) of the NotificationConfiguration
|
496
|
-
# associated with this EventRule
|
584
|
+
# The Amazon Resource Name (ARN) of the `NotificationConfiguration`
|
585
|
+
# associated with this `EventRule`.
|
497
586
|
#
|
498
587
|
# @option params [required, String] :source
|
499
588
|
# The matched event source.
|
500
589
|
#
|
501
|
-
# Must match one of the valid EventBridge sources. Only
|
502
|
-
# sourced events are supported. For example, `aws.ec2`
|
503
|
-
# `aws.cloudwatch`. For more information, see [Event delivery from
|
504
|
-
# services][1] in the *Amazon EventBridge User
|
590
|
+
# Must match one of the valid EventBridge sources. Only Amazon Web
|
591
|
+
# Services service sourced events are supported. For example, `aws.ec2`
|
592
|
+
# and `aws.cloudwatch`. For more information, see [Event delivery from
|
593
|
+
# Amazon Web Services services][1] in the *Amazon EventBridge User
|
594
|
+
# Guide*.
|
505
595
|
#
|
506
596
|
#
|
507
597
|
#
|
@@ -511,9 +601,10 @@ module Aws::Notifications
|
|
511
601
|
# The event type to match.
|
512
602
|
#
|
513
603
|
# Must match one of the valid Amazon EventBridge event types. For
|
514
|
-
# example, EC2 Instance State-change Notification and
|
515
|
-
# Alarm State Change. For more information, see [Event delivery from
|
516
|
-
# services][1] in the *Amazon EventBridge User
|
604
|
+
# example, EC2 Instance State-change Notification and Amazon CloudWatch
|
605
|
+
# Alarm State Change. For more information, see [Event delivery from
|
606
|
+
# Amazon Web Services services][1] in the *Amazon EventBridge User
|
607
|
+
# Guide*.
|
517
608
|
#
|
518
609
|
#
|
519
610
|
#
|
@@ -521,7 +612,7 @@ module Aws::Notifications
|
|
521
612
|
#
|
522
613
|
# @option params [String] :event_pattern
|
523
614
|
# An additional event pattern used to further filter the events this
|
524
|
-
# EventRule receives.
|
615
|
+
# `EventRule` receives.
|
525
616
|
#
|
526
617
|
# For more information, see [Amazon EventBridge event patterns][1] in
|
527
618
|
# the *Amazon EventBridge User Guide.*
|
@@ -531,7 +622,8 @@ module Aws::Notifications
|
|
531
622
|
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html
|
532
623
|
#
|
533
624
|
# @option params [required, Array<String>] :regions
|
534
|
-
# A list of
|
625
|
+
# A list of Amazon Web Services Regions that send events to this
|
626
|
+
# `EventRule`.
|
535
627
|
#
|
536
628
|
# @return [Types::CreateEventRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
537
629
|
#
|
@@ -566,17 +658,17 @@ module Aws::Notifications
|
|
566
658
|
req.send_request(options)
|
567
659
|
end
|
568
660
|
|
569
|
-
# Creates a new NotificationConfiguration
|
661
|
+
# Creates a new `NotificationConfiguration`.
|
570
662
|
#
|
571
663
|
# @option params [required, String] :name
|
572
|
-
# The name of the NotificationConfiguration
|
664
|
+
# The name of the `NotificationConfiguration`. Supports RFC 3986's
|
573
665
|
# unreserved characters.
|
574
666
|
#
|
575
667
|
# @option params [required, String] :description
|
576
|
-
# The description of the NotificationConfiguration
|
668
|
+
# The description of the `NotificationConfiguration`.
|
577
669
|
#
|
578
670
|
# @option params [String] :aggregation_duration
|
579
|
-
# The aggregation preference of the NotificationConfiguration
|
671
|
+
# The aggregation preference of the `NotificationConfiguration`.
|
580
672
|
#
|
581
673
|
# * Values:
|
582
674
|
#
|
@@ -594,7 +686,7 @@ module Aws::Notifications
|
|
594
686
|
#
|
595
687
|
# * Don't aggregate notifications.
|
596
688
|
#
|
597
|
-
#
|
689
|
+
# ^
|
598
690
|
#
|
599
691
|
# @option params [Hash<String,String>] :tags
|
600
692
|
# A map of tags assigned to a resource. A tag is a string-to-string map
|
@@ -630,10 +722,10 @@ module Aws::Notifications
|
|
630
722
|
req.send_request(options)
|
631
723
|
end
|
632
724
|
|
633
|
-
# Deletes an EventRule
|
725
|
+
# Deletes an `EventRule`.
|
634
726
|
#
|
635
727
|
# @option params [required, String] :arn
|
636
|
-
# The Amazon Resource Name (ARN) of the EventRule to delete.
|
728
|
+
# The Amazon Resource Name (ARN) of the `EventRule` to delete.
|
637
729
|
#
|
638
730
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
639
731
|
#
|
@@ -652,10 +744,10 @@ module Aws::Notifications
|
|
652
744
|
req.send_request(options)
|
653
745
|
end
|
654
746
|
|
655
|
-
# Deletes a NotificationConfiguration
|
747
|
+
# Deletes a `NotificationConfiguration`.
|
656
748
|
#
|
657
749
|
# @option params [required, String] :arn
|
658
|
-
# The Amazon Resource Name (ARN) of the NotificationConfiguration to
|
750
|
+
# The Amazon Resource Name (ARN) of the `NotificationConfiguration` to
|
659
751
|
# delete.
|
660
752
|
#
|
661
753
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -675,17 +767,18 @@ module Aws::Notifications
|
|
675
767
|
req.send_request(options)
|
676
768
|
end
|
677
769
|
|
678
|
-
# Deregisters a
|
770
|
+
# Deregisters a `NotificationConfiguration` in the specified Region.
|
679
771
|
#
|
680
|
-
# <note markdown="1"> You can't deregister the last NotificationHub in the account.
|
681
|
-
# NotificationEvents stored in the deregistered
|
682
|
-
# longer be visible. Recreating a new
|
683
|
-
# restores access to
|
772
|
+
# <note markdown="1"> You can't deregister the last `NotificationHub` in the account.
|
773
|
+
# `NotificationEvents` stored in the deregistered
|
774
|
+
# `NotificationConfiguration` are no longer be visible. Recreating a new
|
775
|
+
# `NotificationConfiguration` in the same Region restores access to
|
776
|
+
# those `NotificationEvents`.
|
684
777
|
#
|
685
778
|
# </note>
|
686
779
|
#
|
687
780
|
# @option params [required, String] :notification_hub_region
|
688
|
-
# The
|
781
|
+
# The `NotificationConfiguration` Region.
|
689
782
|
#
|
690
783
|
# @return [Types::DeregisterNotificationHubResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
691
784
|
#
|
@@ -713,15 +806,29 @@ module Aws::Notifications
|
|
713
806
|
req.send_request(options)
|
714
807
|
end
|
715
808
|
|
716
|
-
#
|
717
|
-
#
|
718
|
-
#
|
809
|
+
# Disables service trust between User Notifications and Amazon Web
|
810
|
+
# Services Organizations.
|
811
|
+
#
|
812
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
813
|
+
#
|
814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DisableNotificationsAccessForOrganization AWS API Documentation
|
815
|
+
#
|
816
|
+
# @overload disable_notifications_access_for_organization(params = {})
|
817
|
+
# @param [Hash] params ({})
|
818
|
+
def disable_notifications_access_for_organization(params = {}, options = {})
|
819
|
+
req = build_request(:disable_notifications_access_for_organization, params)
|
820
|
+
req.send_request(options)
|
821
|
+
end
|
822
|
+
|
823
|
+
# Disassociates a Channel from a specified `NotificationConfiguration`.
|
824
|
+
# Supported Channels include Chatbot, the Console Mobile Application,
|
825
|
+
# and emails (notifications-contacts).
|
719
826
|
#
|
720
827
|
# @option params [required, String] :arn
|
721
828
|
# The Amazon Resource Name (ARN) of the Channel to disassociate.
|
722
829
|
#
|
723
830
|
# @option params [required, String] :notification_configuration_arn
|
724
|
-
# The ARN of the NotificationConfiguration to disassociate.
|
831
|
+
# The ARN of the `NotificationConfiguration` to disassociate.
|
725
832
|
#
|
726
833
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
727
834
|
#
|
@@ -741,10 +848,86 @@ module Aws::Notifications
|
|
741
848
|
req.send_request(options)
|
742
849
|
end
|
743
850
|
|
744
|
-
#
|
851
|
+
# Disassociates an Account Contact with a particular
|
852
|
+
# `ManagedNotificationConfiguration`.
|
853
|
+
#
|
854
|
+
# @option params [required, String] :contact_identifier
|
855
|
+
# The unique value of an Account Contact Type to associate with the
|
856
|
+
# `ManagedNotificationConfiguration`.
|
857
|
+
#
|
858
|
+
# @option params [required, String] :managed_notification_configuration_arn
|
859
|
+
# The Amazon Resource Name (ARN) of the
|
860
|
+
# `ManagedNotificationConfiguration` to associate with the Account
|
861
|
+
# Contact.
|
862
|
+
#
|
863
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
864
|
+
#
|
865
|
+
# @example Request syntax with placeholder values
|
866
|
+
#
|
867
|
+
# resp = client.disassociate_managed_notification_account_contact({
|
868
|
+
# contact_identifier: "ACCOUNT_PRIMARY", # required, accepts ACCOUNT_PRIMARY, ACCOUNT_ALTERNATE_BILLING, ACCOUNT_ALTERNATE_OPERATIONS, ACCOUNT_ALTERNATE_SECURITY
|
869
|
+
# managed_notification_configuration_arn: "ManagedNotificationConfigurationOsArn", # required
|
870
|
+
# })
|
871
|
+
#
|
872
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DisassociateManagedNotificationAccountContact AWS API Documentation
|
873
|
+
#
|
874
|
+
# @overload disassociate_managed_notification_account_contact(params = {})
|
875
|
+
# @param [Hash] params ({})
|
876
|
+
def disassociate_managed_notification_account_contact(params = {}, options = {})
|
877
|
+
req = build_request(:disassociate_managed_notification_account_contact, params)
|
878
|
+
req.send_request(options)
|
879
|
+
end
|
880
|
+
|
881
|
+
# Disassociates an additional Channel from a particular
|
882
|
+
# `ManagedNotificationConfiguration`.
|
883
|
+
#
|
884
|
+
# Supported Channels include Chatbot, the Console Mobile Application,
|
885
|
+
# and emails (notifications-contacts).
|
886
|
+
#
|
887
|
+
# @option params [required, String] :channel_arn
|
888
|
+
# The Amazon Resource Name (ARN) of the Channel to associate with the
|
889
|
+
# `ManagedNotificationConfiguration`.
|
890
|
+
#
|
891
|
+
# @option params [required, String] :managed_notification_configuration_arn
|
892
|
+
# The Amazon Resource Name (ARN) of the Managed Notification
|
893
|
+
# Configuration to associate with the additional Channel.
|
894
|
+
#
|
895
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
896
|
+
#
|
897
|
+
# @example Request syntax with placeholder values
|
898
|
+
#
|
899
|
+
# resp = client.disassociate_managed_notification_additional_channel({
|
900
|
+
# channel_arn: "ChannelArn", # required
|
901
|
+
# managed_notification_configuration_arn: "ManagedNotificationConfigurationOsArn", # required
|
902
|
+
# })
|
903
|
+
#
|
904
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DisassociateManagedNotificationAdditionalChannel AWS API Documentation
|
905
|
+
#
|
906
|
+
# @overload disassociate_managed_notification_additional_channel(params = {})
|
907
|
+
# @param [Hash] params ({})
|
908
|
+
def disassociate_managed_notification_additional_channel(params = {}, options = {})
|
909
|
+
req = build_request(:disassociate_managed_notification_additional_channel, params)
|
910
|
+
req.send_request(options)
|
911
|
+
end
|
912
|
+
|
913
|
+
# Enables service trust between User Notifications and Amazon Web
|
914
|
+
# Services Organizations.
|
915
|
+
#
|
916
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
917
|
+
#
|
918
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/EnableNotificationsAccessForOrganization AWS API Documentation
|
919
|
+
#
|
920
|
+
# @overload enable_notifications_access_for_organization(params = {})
|
921
|
+
# @param [Hash] params ({})
|
922
|
+
def enable_notifications_access_for_organization(params = {}, options = {})
|
923
|
+
req = build_request(:enable_notifications_access_for_organization, params)
|
924
|
+
req.send_request(options)
|
925
|
+
end
|
926
|
+
|
927
|
+
# Returns a specified `EventRule`.
|
745
928
|
#
|
746
929
|
# @option params [required, String] :arn
|
747
|
-
# The Amazon Resource Name (ARN) of the EventRule to return.
|
930
|
+
# The Amazon Resource Name (ARN) of the `EventRule` to return.
|
748
931
|
#
|
749
932
|
# @return [Types::GetEventRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
750
933
|
#
|
@@ -789,10 +972,195 @@ module Aws::Notifications
|
|
789
972
|
req.send_request(options)
|
790
973
|
end
|
791
974
|
|
792
|
-
# Returns a
|
975
|
+
# Returns the child event of a specific given
|
976
|
+
# `ManagedNotificationEvent`.
|
793
977
|
#
|
794
978
|
# @option params [required, String] :arn
|
795
|
-
# The Amazon Resource Name (ARN) of the
|
979
|
+
# The Amazon Resource Name (ARN) of the `ManagedNotificationChildEvent`
|
980
|
+
# to return.
|
981
|
+
#
|
982
|
+
# @option params [String] :locale
|
983
|
+
# The locale code of the language used for the retrieved
|
984
|
+
# `ManagedNotificationChildEvent`. The default locale is English
|
985
|
+
# `en_US`.
|
986
|
+
#
|
987
|
+
# @return [Types::GetManagedNotificationChildEventResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
988
|
+
#
|
989
|
+
# * {Types::GetManagedNotificationChildEventResponse#arn #arn} => String
|
990
|
+
# * {Types::GetManagedNotificationChildEventResponse#managed_notification_configuration_arn #managed_notification_configuration_arn} => String
|
991
|
+
# * {Types::GetManagedNotificationChildEventResponse#creation_time #creation_time} => Time
|
992
|
+
# * {Types::GetManagedNotificationChildEventResponse#content #content} => Types::ManagedNotificationChildEvent
|
993
|
+
#
|
994
|
+
# @example Request syntax with placeholder values
|
995
|
+
#
|
996
|
+
# resp = client.get_managed_notification_child_event({
|
997
|
+
# arn: "ManagedNotificationChildEventArn", # required
|
998
|
+
# locale: "de_DE", # accepts de_DE, en_CA, en_US, en_UK, es_ES, fr_CA, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, tr_TR, zh_CN, zh_TW
|
999
|
+
# })
|
1000
|
+
#
|
1001
|
+
# @example Response structure
|
1002
|
+
#
|
1003
|
+
# resp.arn #=> String
|
1004
|
+
# resp.managed_notification_configuration_arn #=> String
|
1005
|
+
# resp.creation_time #=> Time
|
1006
|
+
# resp.content.schema_version #=> String, one of "v1.0"
|
1007
|
+
# resp.content.id #=> String
|
1008
|
+
# resp.content.message_components.headline #=> String
|
1009
|
+
# resp.content.message_components.paragraph_summary #=> String
|
1010
|
+
# resp.content.message_components.complete_description #=> String
|
1011
|
+
# resp.content.message_components.dimensions #=> Array
|
1012
|
+
# resp.content.message_components.dimensions[0].name #=> String
|
1013
|
+
# resp.content.message_components.dimensions[0].value #=> String
|
1014
|
+
# resp.content.source_event_detail_url #=> String
|
1015
|
+
# resp.content.source_event_detail_url_display_text #=> String
|
1016
|
+
# resp.content.notification_type #=> String, one of "ALERT", "WARNING", "ANNOUNCEMENT", "INFORMATIONAL"
|
1017
|
+
# resp.content.event_status #=> String, one of "HEALTHY", "UNHEALTHY"
|
1018
|
+
# resp.content.aggregate_managed_notification_event_arn #=> String
|
1019
|
+
# resp.content.start_time #=> Time
|
1020
|
+
# resp.content.end_time #=> Time
|
1021
|
+
# resp.content.text_parts #=> Hash
|
1022
|
+
# resp.content.text_parts["TextPartId"].type #=> String, one of "LOCALIZED_TEXT", "PLAIN_TEXT", "URL"
|
1023
|
+
# resp.content.text_parts["TextPartId"].display_text #=> String
|
1024
|
+
# resp.content.text_parts["TextPartId"].text_by_locale #=> Hash
|
1025
|
+
# resp.content.text_parts["TextPartId"].text_by_locale["LocaleCode"] #=> String
|
1026
|
+
# resp.content.text_parts["TextPartId"].url #=> String
|
1027
|
+
# resp.content.organizational_unit_id #=> String
|
1028
|
+
# resp.content.aggregation_detail.summarization_dimensions #=> Array
|
1029
|
+
# resp.content.aggregation_detail.summarization_dimensions[0].name #=> String
|
1030
|
+
# resp.content.aggregation_detail.summarization_dimensions[0].value #=> String
|
1031
|
+
#
|
1032
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetManagedNotificationChildEvent AWS API Documentation
|
1033
|
+
#
|
1034
|
+
# @overload get_managed_notification_child_event(params = {})
|
1035
|
+
# @param [Hash] params ({})
|
1036
|
+
def get_managed_notification_child_event(params = {}, options = {})
|
1037
|
+
req = build_request(:get_managed_notification_child_event, params)
|
1038
|
+
req.send_request(options)
|
1039
|
+
end
|
1040
|
+
|
1041
|
+
# Returns a specified `ManagedNotificationConfiguration`.
|
1042
|
+
#
|
1043
|
+
# @option params [required, String] :arn
|
1044
|
+
# The Amazon Resource Name (ARN) of the
|
1045
|
+
# `ManagedNotificationConfiguration` to return.
|
1046
|
+
#
|
1047
|
+
# @return [Types::GetManagedNotificationConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1048
|
+
#
|
1049
|
+
# * {Types::GetManagedNotificationConfigurationResponse#arn #arn} => String
|
1050
|
+
# * {Types::GetManagedNotificationConfigurationResponse#name #name} => String
|
1051
|
+
# * {Types::GetManagedNotificationConfigurationResponse#description #description} => String
|
1052
|
+
# * {Types::GetManagedNotificationConfigurationResponse#category #category} => String
|
1053
|
+
# * {Types::GetManagedNotificationConfigurationResponse#sub_category #sub_category} => String
|
1054
|
+
#
|
1055
|
+
# @example Request syntax with placeholder values
|
1056
|
+
#
|
1057
|
+
# resp = client.get_managed_notification_configuration({
|
1058
|
+
# arn: "ManagedNotificationConfigurationOsArn", # required
|
1059
|
+
# })
|
1060
|
+
#
|
1061
|
+
# @example Response structure
|
1062
|
+
#
|
1063
|
+
# resp.arn #=> String
|
1064
|
+
# resp.name #=> String
|
1065
|
+
# resp.description #=> String
|
1066
|
+
# resp.category #=> String
|
1067
|
+
# resp.sub_category #=> String
|
1068
|
+
#
|
1069
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetManagedNotificationConfiguration AWS API Documentation
|
1070
|
+
#
|
1071
|
+
# @overload get_managed_notification_configuration(params = {})
|
1072
|
+
# @param [Hash] params ({})
|
1073
|
+
def get_managed_notification_configuration(params = {}, options = {})
|
1074
|
+
req = build_request(:get_managed_notification_configuration, params)
|
1075
|
+
req.send_request(options)
|
1076
|
+
end
|
1077
|
+
|
1078
|
+
# Returns a specified `ManagedNotificationEvent`.
|
1079
|
+
#
|
1080
|
+
# @option params [required, String] :arn
|
1081
|
+
# The Amazon Resource Name (ARN) of the `ManagedNotificationEvent` to
|
1082
|
+
# return.
|
1083
|
+
#
|
1084
|
+
# @option params [String] :locale
|
1085
|
+
# The locale code of the language used for the retrieved
|
1086
|
+
# `ManagedNotificationEvent`. The default locale is English `(en_US)`.
|
1087
|
+
#
|
1088
|
+
# @return [Types::GetManagedNotificationEventResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1089
|
+
#
|
1090
|
+
# * {Types::GetManagedNotificationEventResponse#arn #arn} => String
|
1091
|
+
# * {Types::GetManagedNotificationEventResponse#managed_notification_configuration_arn #managed_notification_configuration_arn} => String
|
1092
|
+
# * {Types::GetManagedNotificationEventResponse#creation_time #creation_time} => Time
|
1093
|
+
# * {Types::GetManagedNotificationEventResponse#content #content} => Types::ManagedNotificationEvent
|
1094
|
+
#
|
1095
|
+
# @example Request syntax with placeholder values
|
1096
|
+
#
|
1097
|
+
# resp = client.get_managed_notification_event({
|
1098
|
+
# arn: "ManagedNotificationEventArn", # required
|
1099
|
+
# locale: "de_DE", # accepts de_DE, en_CA, en_US, en_UK, es_ES, fr_CA, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, tr_TR, zh_CN, zh_TW
|
1100
|
+
# })
|
1101
|
+
#
|
1102
|
+
# @example Response structure
|
1103
|
+
#
|
1104
|
+
# resp.arn #=> String
|
1105
|
+
# resp.managed_notification_configuration_arn #=> String
|
1106
|
+
# resp.creation_time #=> Time
|
1107
|
+
# resp.content.schema_version #=> String, one of "v1.0"
|
1108
|
+
# resp.content.id #=> String
|
1109
|
+
# resp.content.message_components.headline #=> String
|
1110
|
+
# resp.content.message_components.paragraph_summary #=> String
|
1111
|
+
# resp.content.message_components.complete_description #=> String
|
1112
|
+
# resp.content.message_components.dimensions #=> Array
|
1113
|
+
# resp.content.message_components.dimensions[0].name #=> String
|
1114
|
+
# resp.content.message_components.dimensions[0].value #=> String
|
1115
|
+
# resp.content.source_event_detail_url #=> String
|
1116
|
+
# resp.content.source_event_detail_url_display_text #=> String
|
1117
|
+
# resp.content.notification_type #=> String, one of "ALERT", "WARNING", "ANNOUNCEMENT", "INFORMATIONAL"
|
1118
|
+
# resp.content.event_status #=> String, one of "HEALTHY", "UNHEALTHY"
|
1119
|
+
# resp.content.aggregation_event_type #=> String, one of "AGGREGATE", "CHILD", "NONE"
|
1120
|
+
# resp.content.aggregation_summary.event_count #=> Integer
|
1121
|
+
# resp.content.aggregation_summary.aggregated_by #=> Array
|
1122
|
+
# resp.content.aggregation_summary.aggregated_by[0].name #=> String
|
1123
|
+
# resp.content.aggregation_summary.aggregated_by[0].value #=> String
|
1124
|
+
# resp.content.aggregation_summary.aggregated_accounts.name #=> String
|
1125
|
+
# resp.content.aggregation_summary.aggregated_accounts.count #=> Integer
|
1126
|
+
# resp.content.aggregation_summary.aggregated_accounts.sample_values #=> Array
|
1127
|
+
# resp.content.aggregation_summary.aggregated_accounts.sample_values[0] #=> String
|
1128
|
+
# resp.content.aggregation_summary.aggregated_regions.name #=> String
|
1129
|
+
# resp.content.aggregation_summary.aggregated_regions.count #=> Integer
|
1130
|
+
# resp.content.aggregation_summary.aggregated_regions.sample_values #=> Array
|
1131
|
+
# resp.content.aggregation_summary.aggregated_regions.sample_values[0] #=> String
|
1132
|
+
# resp.content.aggregation_summary.aggregated_organizational_units.name #=> String
|
1133
|
+
# resp.content.aggregation_summary.aggregated_organizational_units.count #=> Integer
|
1134
|
+
# resp.content.aggregation_summary.aggregated_organizational_units.sample_values #=> Array
|
1135
|
+
# resp.content.aggregation_summary.aggregated_organizational_units.sample_values[0] #=> String
|
1136
|
+
# resp.content.aggregation_summary.additional_summarization_dimensions #=> Array
|
1137
|
+
# resp.content.aggregation_summary.additional_summarization_dimensions[0].name #=> String
|
1138
|
+
# resp.content.aggregation_summary.additional_summarization_dimensions[0].count #=> Integer
|
1139
|
+
# resp.content.aggregation_summary.additional_summarization_dimensions[0].sample_values #=> Array
|
1140
|
+
# resp.content.aggregation_summary.additional_summarization_dimensions[0].sample_values[0] #=> String
|
1141
|
+
# resp.content.start_time #=> Time
|
1142
|
+
# resp.content.end_time #=> Time
|
1143
|
+
# resp.content.text_parts #=> Hash
|
1144
|
+
# resp.content.text_parts["TextPartId"].type #=> String, one of "LOCALIZED_TEXT", "PLAIN_TEXT", "URL"
|
1145
|
+
# resp.content.text_parts["TextPartId"].display_text #=> String
|
1146
|
+
# resp.content.text_parts["TextPartId"].text_by_locale #=> Hash
|
1147
|
+
# resp.content.text_parts["TextPartId"].text_by_locale["LocaleCode"] #=> String
|
1148
|
+
# resp.content.text_parts["TextPartId"].url #=> String
|
1149
|
+
# resp.content.organizational_unit_id #=> String
|
1150
|
+
#
|
1151
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetManagedNotificationEvent AWS API Documentation
|
1152
|
+
#
|
1153
|
+
# @overload get_managed_notification_event(params = {})
|
1154
|
+
# @param [Hash] params ({})
|
1155
|
+
def get_managed_notification_event(params = {}, options = {})
|
1156
|
+
req = build_request(:get_managed_notification_event, params)
|
1157
|
+
req.send_request(options)
|
1158
|
+
end
|
1159
|
+
|
1160
|
+
# Returns a specified `NotificationConfiguration`.
|
1161
|
+
#
|
1162
|
+
# @option params [required, String] :arn
|
1163
|
+
# The Amazon Resource Name (ARN) of the `NotificationConfiguration` to
|
796
1164
|
# return.
|
797
1165
|
#
|
798
1166
|
# @return [Types::GetNotificationConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -828,27 +1196,27 @@ module Aws::Notifications
|
|
828
1196
|
req.send_request(options)
|
829
1197
|
end
|
830
1198
|
|
831
|
-
# Returns a specified NotificationEvent
|
1199
|
+
# Returns a specified `NotificationEvent`.
|
832
1200
|
#
|
833
1201
|
# User Notifications stores notifications in the individual Regions you
|
834
1202
|
# register as notification hubs and the Region of the source event rule.
|
835
|
-
# GetNotificationEvent only returns notifications stored in the same
|
1203
|
+
# `GetNotificationEvent` only returns notifications stored in the same
|
836
1204
|
# Region in which the action is called. User Notifications doesn't
|
837
1205
|
# backfill notifications to new Regions selected as notification hubs.
|
838
1206
|
# For this reason, we recommend that you make calls in your oldest
|
839
1207
|
# registered notification hub. For more information, see [Notification
|
840
|
-
# hubs][1] in the *
|
1208
|
+
# hubs][1] in the *Amazon Web Services User Notifications User Guide*.
|
841
1209
|
#
|
842
1210
|
#
|
843
1211
|
#
|
844
1212
|
# [1]: https://docs.aws.amazon.com/notifications/latest/userguide/notification-hubs.html
|
845
1213
|
#
|
846
1214
|
# @option params [required, String] :arn
|
847
|
-
# The Amazon Resource Name (ARN) of the NotificationEvent to return.
|
1215
|
+
# The Amazon Resource Name (ARN) of the `NotificationEvent` to return.
|
848
1216
|
#
|
849
1217
|
# @option params [String] :locale
|
850
1218
|
# The locale code of the language used for the retrieved
|
851
|
-
# NotificationEvent
|
1219
|
+
# `NotificationEvent`. The default locale is English `en_US`.
|
852
1220
|
#
|
853
1221
|
# @return [Types::GetNotificationEventResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
854
1222
|
#
|
@@ -896,6 +1264,27 @@ module Aws::Notifications
|
|
896
1264
|
# resp.content.event_status #=> String, one of "HEALTHY", "UNHEALTHY"
|
897
1265
|
# resp.content.aggregation_event_type #=> String, one of "AGGREGATE", "CHILD", "NONE"
|
898
1266
|
# resp.content.aggregate_notification_event_arn #=> String
|
1267
|
+
# resp.content.aggregation_summary.event_count #=> Integer
|
1268
|
+
# resp.content.aggregation_summary.aggregated_by #=> Array
|
1269
|
+
# resp.content.aggregation_summary.aggregated_by[0].name #=> String
|
1270
|
+
# resp.content.aggregation_summary.aggregated_by[0].value #=> String
|
1271
|
+
# resp.content.aggregation_summary.aggregated_accounts.name #=> String
|
1272
|
+
# resp.content.aggregation_summary.aggregated_accounts.count #=> Integer
|
1273
|
+
# resp.content.aggregation_summary.aggregated_accounts.sample_values #=> Array
|
1274
|
+
# resp.content.aggregation_summary.aggregated_accounts.sample_values[0] #=> String
|
1275
|
+
# resp.content.aggregation_summary.aggregated_regions.name #=> String
|
1276
|
+
# resp.content.aggregation_summary.aggregated_regions.count #=> Integer
|
1277
|
+
# resp.content.aggregation_summary.aggregated_regions.sample_values #=> Array
|
1278
|
+
# resp.content.aggregation_summary.aggregated_regions.sample_values[0] #=> String
|
1279
|
+
# resp.content.aggregation_summary.aggregated_organizational_units.name #=> String
|
1280
|
+
# resp.content.aggregation_summary.aggregated_organizational_units.count #=> Integer
|
1281
|
+
# resp.content.aggregation_summary.aggregated_organizational_units.sample_values #=> Array
|
1282
|
+
# resp.content.aggregation_summary.aggregated_organizational_units.sample_values[0] #=> String
|
1283
|
+
# resp.content.aggregation_summary.additional_summarization_dimensions #=> Array
|
1284
|
+
# resp.content.aggregation_summary.additional_summarization_dimensions[0].name #=> String
|
1285
|
+
# resp.content.aggregation_summary.additional_summarization_dimensions[0].count #=> Integer
|
1286
|
+
# resp.content.aggregation_summary.additional_summarization_dimensions[0].sample_values #=> Array
|
1287
|
+
# resp.content.aggregation_summary.additional_summarization_dimensions[0].sample_values[0] #=> String
|
899
1288
|
# resp.content.start_time #=> Time
|
900
1289
|
# resp.content.end_time #=> Time
|
901
1290
|
# resp.content.text_parts #=> Hash
|
@@ -919,10 +1308,30 @@ module Aws::Notifications
|
|
919
1308
|
req.send_request(options)
|
920
1309
|
end
|
921
1310
|
|
922
|
-
# Returns
|
1311
|
+
# Returns the AccessStatus of Service Trust Enablement for User
|
1312
|
+
# Notifications and Amazon Web Services Organizations.
|
1313
|
+
#
|
1314
|
+
# @return [Types::GetNotificationsAccessForOrganizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1315
|
+
#
|
1316
|
+
# * {Types::GetNotificationsAccessForOrganizationResponse#notifications_access_for_organization #notifications_access_for_organization} => Types::NotificationsAccessForOrganization
|
1317
|
+
#
|
1318
|
+
# @example Response structure
|
1319
|
+
#
|
1320
|
+
# resp.notifications_access_for_organization.access_status #=> String, one of "ENABLED", "DISABLED", "PENDING"
|
1321
|
+
#
|
1322
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetNotificationsAccessForOrganization AWS API Documentation
|
1323
|
+
#
|
1324
|
+
# @overload get_notifications_access_for_organization(params = {})
|
1325
|
+
# @param [Hash] params ({})
|
1326
|
+
def get_notifications_access_for_organization(params = {}, options = {})
|
1327
|
+
req = build_request(:get_notifications_access_for_organization, params)
|
1328
|
+
req.send_request(options)
|
1329
|
+
end
|
1330
|
+
|
1331
|
+
# Returns a list of Channels for a `NotificationConfiguration`.
|
923
1332
|
#
|
924
1333
|
# @option params [required, String] :notification_configuration_arn
|
925
|
-
# The Amazon Resource Name (ARN) of the NotificationConfiguration
|
1334
|
+
# The Amazon Resource Name (ARN) of the `NotificationConfiguration`.
|
926
1335
|
#
|
927
1336
|
# @option params [Integer] :max_results
|
928
1337
|
# The maximum number of results to be returned in this call. The default
|
@@ -930,7 +1339,8 @@ module Aws::Notifications
|
|
930
1339
|
#
|
931
1340
|
# @option params [String] :next_token
|
932
1341
|
# The start token for paginated calls. Retrieved from the response of a
|
933
|
-
# previous ListNotificationEvents call. NextToken uses Base64
|
1342
|
+
# previous ListNotificationEvents call. `NextToken` uses Base64
|
1343
|
+
# encoding.
|
934
1344
|
#
|
935
1345
|
# @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
936
1346
|
#
|
@@ -962,11 +1372,11 @@ module Aws::Notifications
|
|
962
1372
|
req.send_request(options)
|
963
1373
|
end
|
964
1374
|
|
965
|
-
# Returns a list of EventRules according to specified filters, in
|
1375
|
+
# Returns a list of `EventRules` according to specified filters, in
|
966
1376
|
# reverse chronological order (newest first).
|
967
1377
|
#
|
968
1378
|
# @option params [required, String] :notification_configuration_arn
|
969
|
-
# The Amazon Resource Name (ARN) of the NotificationConfiguration
|
1379
|
+
# The Amazon Resource Name (ARN) of the `NotificationConfiguration`.
|
970
1380
|
#
|
971
1381
|
# @option params [Integer] :max_results
|
972
1382
|
# The maximum number of results to be returned in this call. The default
|
@@ -974,7 +1384,7 @@ module Aws::Notifications
|
|
974
1384
|
#
|
975
1385
|
# @option params [String] :next_token
|
976
1386
|
# The start token for paginated calls. Retrieved from the response of a
|
977
|
-
# previous ListEventRules call. Next token uses Base64 encoding.
|
1387
|
+
# previous `ListEventRules` call. Next token uses Base64 encoding.
|
978
1388
|
#
|
979
1389
|
# @return [Types::ListEventRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
980
1390
|
#
|
@@ -1018,16 +1428,302 @@ module Aws::Notifications
|
|
1018
1428
|
req.send_request(options)
|
1019
1429
|
end
|
1020
1430
|
|
1021
|
-
# Returns a list of
|
1022
|
-
#
|
1431
|
+
# Returns a list of Account contacts and Channels associated with a
|
1432
|
+
# `ManagedNotificationConfiguration`, in paginated format.
|
1433
|
+
#
|
1434
|
+
# @option params [required, String] :managed_notification_configuration_arn
|
1435
|
+
# The Amazon Resource Name (ARN) of the
|
1436
|
+
# `ManagedNotificationConfiguration` to match.
|
1437
|
+
#
|
1438
|
+
# @option params [Integer] :max_results
|
1439
|
+
# The maximum number of results to be returned in this call. Defaults to
|
1440
|
+
# 20.
|
1441
|
+
#
|
1442
|
+
# @option params [String] :next_token
|
1443
|
+
# The start token for paginated calls. Retrieved from the response of a
|
1444
|
+
# previous `ListManagedNotificationChannelAssociations` call.
|
1445
|
+
#
|
1446
|
+
# @return [Types::ListManagedNotificationChannelAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1447
|
+
#
|
1448
|
+
# * {Types::ListManagedNotificationChannelAssociationsResponse#next_token #next_token} => String
|
1449
|
+
# * {Types::ListManagedNotificationChannelAssociationsResponse#channel_associations #channel_associations} => Array<Types::ManagedNotificationChannelAssociationSummary>
|
1450
|
+
#
|
1451
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1452
|
+
#
|
1453
|
+
# @example Request syntax with placeholder values
|
1454
|
+
#
|
1455
|
+
# resp = client.list_managed_notification_channel_associations({
|
1456
|
+
# managed_notification_configuration_arn: "ManagedNotificationConfigurationOsArn", # required
|
1457
|
+
# max_results: 1,
|
1458
|
+
# next_token: "NextToken",
|
1459
|
+
# })
|
1460
|
+
#
|
1461
|
+
# @example Response structure
|
1462
|
+
#
|
1463
|
+
# resp.next_token #=> String
|
1464
|
+
# resp.channel_associations #=> Array
|
1465
|
+
# resp.channel_associations[0].channel_identifier #=> String
|
1466
|
+
# resp.channel_associations[0].channel_type #=> String, one of "MOBILE", "CHATBOT", "EMAIL", "ACCOUNT_CONTACT"
|
1467
|
+
# resp.channel_associations[0].override_option #=> String, one of "ENABLED", "DISABLED"
|
1468
|
+
#
|
1469
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListManagedNotificationChannelAssociations AWS API Documentation
|
1470
|
+
#
|
1471
|
+
# @overload list_managed_notification_channel_associations(params = {})
|
1472
|
+
# @param [Hash] params ({})
|
1473
|
+
def list_managed_notification_channel_associations(params = {}, options = {})
|
1474
|
+
req = build_request(:list_managed_notification_channel_associations, params)
|
1475
|
+
req.send_request(options)
|
1476
|
+
end
|
1477
|
+
|
1478
|
+
# Returns a list of `ManagedNotificationChildEvents` for a specified
|
1479
|
+
# aggregate `ManagedNotificationEvent`, ordered by creation time in
|
1480
|
+
# reverse chronological order (newest first).
|
1481
|
+
#
|
1482
|
+
# @option params [required, String] :aggregate_managed_notification_event_arn
|
1483
|
+
# The Amazon Resource Name (ARN) of the `ManagedNotificationEvent`.
|
1484
|
+
#
|
1485
|
+
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
1486
|
+
# The earliest time of events to return from this call.
|
1487
|
+
#
|
1488
|
+
# @option params [Time,DateTime,Date,Integer,String] :end_time
|
1489
|
+
# Latest time of events to return from this call.
|
1490
|
+
#
|
1491
|
+
# @option params [String] :locale
|
1492
|
+
# The locale code of the language used for the retrieved
|
1493
|
+
# `NotificationEvent`. The default locale is English.`en_US`.
|
1494
|
+
#
|
1495
|
+
# @option params [Integer] :max_results
|
1496
|
+
# The maximum number of results to be returned in this call. Defaults to
|
1497
|
+
# 20.
|
1498
|
+
#
|
1499
|
+
# @option params [String] :related_account
|
1500
|
+
# The Amazon Web Services account ID associated with the Managed
|
1501
|
+
# Notification Child Events.
|
1502
|
+
#
|
1503
|
+
# @option params [String] :organizational_unit_id
|
1504
|
+
# The identifier of the Amazon Web Services Organizations organizational
|
1505
|
+
# unit (OU) associated with the Managed Notification Child Events.
|
1506
|
+
#
|
1507
|
+
# @option params [String] :next_token
|
1508
|
+
# The start token for paginated calls. Retrieved from the response of a
|
1509
|
+
# previous ListManagedNotificationChannelAssociations call. Next token
|
1510
|
+
# uses Base64 encoding.
|
1511
|
+
#
|
1512
|
+
# @return [Types::ListManagedNotificationChildEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1513
|
+
#
|
1514
|
+
# * {Types::ListManagedNotificationChildEventsResponse#next_token #next_token} => String
|
1515
|
+
# * {Types::ListManagedNotificationChildEventsResponse#managed_notification_child_events #managed_notification_child_events} => Array<Types::ManagedNotificationChildEventOverview>
|
1516
|
+
#
|
1517
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1518
|
+
#
|
1519
|
+
# @example Request syntax with placeholder values
|
1520
|
+
#
|
1521
|
+
# resp = client.list_managed_notification_child_events({
|
1522
|
+
# aggregate_managed_notification_event_arn: "ManagedNotificationEventArn", # required
|
1523
|
+
# start_time: Time.now,
|
1524
|
+
# end_time: Time.now,
|
1525
|
+
# locale: "de_DE", # accepts de_DE, en_CA, en_US, en_UK, es_ES, fr_CA, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, tr_TR, zh_CN, zh_TW
|
1526
|
+
# max_results: 1,
|
1527
|
+
# related_account: "AccountId",
|
1528
|
+
# organizational_unit_id: "OrganizationalUnitId",
|
1529
|
+
# next_token: "NextToken",
|
1530
|
+
# })
|
1531
|
+
#
|
1532
|
+
# @example Response structure
|
1533
|
+
#
|
1534
|
+
# resp.next_token #=> String
|
1535
|
+
# resp.managed_notification_child_events #=> Array
|
1536
|
+
# resp.managed_notification_child_events[0].arn #=> String
|
1537
|
+
# resp.managed_notification_child_events[0].managed_notification_configuration_arn #=> String
|
1538
|
+
# resp.managed_notification_child_events[0].related_account #=> String
|
1539
|
+
# resp.managed_notification_child_events[0].creation_time #=> Time
|
1540
|
+
# resp.managed_notification_child_events[0].child_event.schema_version #=> String, one of "v1.0"
|
1541
|
+
# resp.managed_notification_child_events[0].child_event.source_event_metadata.event_origin_region #=> String
|
1542
|
+
# resp.managed_notification_child_events[0].child_event.source_event_metadata.source #=> String
|
1543
|
+
# resp.managed_notification_child_events[0].child_event.source_event_metadata.event_type #=> String
|
1544
|
+
# resp.managed_notification_child_events[0].child_event.message_components.headline #=> String
|
1545
|
+
# resp.managed_notification_child_events[0].child_event.aggregation_detail.summarization_dimensions #=> Array
|
1546
|
+
# resp.managed_notification_child_events[0].child_event.aggregation_detail.summarization_dimensions[0].name #=> String
|
1547
|
+
# resp.managed_notification_child_events[0].child_event.aggregation_detail.summarization_dimensions[0].value #=> String
|
1548
|
+
# resp.managed_notification_child_events[0].child_event.event_status #=> String, one of "HEALTHY", "UNHEALTHY"
|
1549
|
+
# resp.managed_notification_child_events[0].child_event.notification_type #=> String, one of "ALERT", "WARNING", "ANNOUNCEMENT", "INFORMATIONAL"
|
1550
|
+
# resp.managed_notification_child_events[0].aggregate_managed_notification_event_arn #=> String
|
1551
|
+
# resp.managed_notification_child_events[0].organizational_unit_id #=> String
|
1552
|
+
#
|
1553
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListManagedNotificationChildEvents AWS API Documentation
|
1554
|
+
#
|
1555
|
+
# @overload list_managed_notification_child_events(params = {})
|
1556
|
+
# @param [Hash] params ({})
|
1557
|
+
def list_managed_notification_child_events(params = {}, options = {})
|
1558
|
+
req = build_request(:list_managed_notification_child_events, params)
|
1559
|
+
req.send_request(options)
|
1560
|
+
end
|
1561
|
+
|
1562
|
+
# Returns a list of Managed Notification Configurations according to
|
1563
|
+
# specified filters, ordered by creation time in reverse chronological
|
1564
|
+
# order (newest first).
|
1565
|
+
#
|
1566
|
+
# @option params [String] :channel_identifier
|
1567
|
+
# The identifier or ARN of the notification channel to filter
|
1568
|
+
# configurations by.
|
1569
|
+
#
|
1570
|
+
# @option params [Integer] :max_results
|
1571
|
+
# The maximum number of results to be returned in this call. Defaults to
|
1572
|
+
# 20.
|
1573
|
+
#
|
1574
|
+
# @option params [String] :next_token
|
1575
|
+
# The start token for paginated calls. Retrieved from the response of a
|
1576
|
+
# previous ListManagedNotificationChannelAssociations call. Next token
|
1577
|
+
# uses Base64 encoding.
|
1578
|
+
#
|
1579
|
+
# @return [Types::ListManagedNotificationConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1580
|
+
#
|
1581
|
+
# * {Types::ListManagedNotificationConfigurationsResponse#next_token #next_token} => String
|
1582
|
+
# * {Types::ListManagedNotificationConfigurationsResponse#managed_notification_configurations #managed_notification_configurations} => Array<Types::ManagedNotificationConfigurationStructure>
|
1583
|
+
#
|
1584
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1585
|
+
#
|
1586
|
+
# @example Request syntax with placeholder values
|
1587
|
+
#
|
1588
|
+
# resp = client.list_managed_notification_configurations({
|
1589
|
+
# channel_identifier: "ChannelIdentifier",
|
1590
|
+
# max_results: 1,
|
1591
|
+
# next_token: "NextToken",
|
1592
|
+
# })
|
1593
|
+
#
|
1594
|
+
# @example Response structure
|
1595
|
+
#
|
1596
|
+
# resp.next_token #=> String
|
1597
|
+
# resp.managed_notification_configurations #=> Array
|
1598
|
+
# resp.managed_notification_configurations[0].arn #=> String
|
1599
|
+
# resp.managed_notification_configurations[0].name #=> String
|
1600
|
+
# resp.managed_notification_configurations[0].description #=> String
|
1601
|
+
#
|
1602
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListManagedNotificationConfigurations AWS API Documentation
|
1603
|
+
#
|
1604
|
+
# @overload list_managed_notification_configurations(params = {})
|
1605
|
+
# @param [Hash] params ({})
|
1606
|
+
def list_managed_notification_configurations(params = {}, options = {})
|
1607
|
+
req = build_request(:list_managed_notification_configurations, params)
|
1608
|
+
req.send_request(options)
|
1609
|
+
end
|
1610
|
+
|
1611
|
+
# Returns a list of Managed Notification Events according to specified
|
1612
|
+
# filters, ordered by creation time in reverse chronological order
|
1613
|
+
# (newest first).
|
1614
|
+
#
|
1615
|
+
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
1616
|
+
# The earliest time of events to return from this call.
|
1617
|
+
#
|
1618
|
+
# @option params [Time,DateTime,Date,Integer,String] :end_time
|
1619
|
+
# Latest time of events to return from this call.
|
1620
|
+
#
|
1621
|
+
# @option params [String] :locale
|
1622
|
+
# The locale code of the language used for the retrieved
|
1623
|
+
# NotificationEvent. The default locale is English (en\_US).
|
1624
|
+
#
|
1625
|
+
# @option params [String] :source
|
1626
|
+
# The Amazon Web Services service the event originates from. For example
|
1627
|
+
# aws.cloudwatch.
|
1628
|
+
#
|
1629
|
+
# @option params [Integer] :max_results
|
1630
|
+
# The maximum number of results to be returned in this call. Defaults to
|
1631
|
+
# 20.
|
1632
|
+
#
|
1633
|
+
# @option params [String] :next_token
|
1634
|
+
# The start token for paginated calls. Retrieved from the response of a
|
1635
|
+
# previous `ListManagedNotificationChannelAssociations` call. Next token
|
1636
|
+
# uses Base64 encoding.
|
1637
|
+
#
|
1638
|
+
# @option params [String] :organizational_unit_id
|
1639
|
+
# The Organizational Unit Id that an Amazon Web Services account belongs
|
1640
|
+
# to.
|
1641
|
+
#
|
1642
|
+
# @option params [String] :related_account
|
1643
|
+
# The Amazon Web Services account ID associated with the Managed
|
1644
|
+
# Notification Events.
|
1645
|
+
#
|
1646
|
+
# @return [Types::ListManagedNotificationEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1647
|
+
#
|
1648
|
+
# * {Types::ListManagedNotificationEventsResponse#next_token #next_token} => String
|
1649
|
+
# * {Types::ListManagedNotificationEventsResponse#managed_notification_events #managed_notification_events} => Array<Types::ManagedNotificationEventOverview>
|
1650
|
+
#
|
1651
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1652
|
+
#
|
1653
|
+
# @example Request syntax with placeholder values
|
1654
|
+
#
|
1655
|
+
# resp = client.list_managed_notification_events({
|
1656
|
+
# start_time: Time.now,
|
1657
|
+
# end_time: Time.now,
|
1658
|
+
# locale: "de_DE", # accepts de_DE, en_CA, en_US, en_UK, es_ES, fr_CA, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, tr_TR, zh_CN, zh_TW
|
1659
|
+
# source: "Source",
|
1660
|
+
# max_results: 1,
|
1661
|
+
# next_token: "NextToken",
|
1662
|
+
# organizational_unit_id: "OrganizationalUnitId",
|
1663
|
+
# related_account: "AccountId",
|
1664
|
+
# })
|
1665
|
+
#
|
1666
|
+
# @example Response structure
|
1667
|
+
#
|
1668
|
+
# resp.next_token #=> String
|
1669
|
+
# resp.managed_notification_events #=> Array
|
1670
|
+
# resp.managed_notification_events[0].arn #=> String
|
1671
|
+
# resp.managed_notification_events[0].managed_notification_configuration_arn #=> String
|
1672
|
+
# resp.managed_notification_events[0].related_account #=> String
|
1673
|
+
# resp.managed_notification_events[0].creation_time #=> Time
|
1674
|
+
# resp.managed_notification_events[0].notification_event.schema_version #=> String, one of "v1.0"
|
1675
|
+
# resp.managed_notification_events[0].notification_event.source_event_metadata.event_origin_region #=> String
|
1676
|
+
# resp.managed_notification_events[0].notification_event.source_event_metadata.source #=> String
|
1677
|
+
# resp.managed_notification_events[0].notification_event.source_event_metadata.event_type #=> String
|
1678
|
+
# resp.managed_notification_events[0].notification_event.message_components.headline #=> String
|
1679
|
+
# resp.managed_notification_events[0].notification_event.event_status #=> String, one of "HEALTHY", "UNHEALTHY"
|
1680
|
+
# resp.managed_notification_events[0].notification_event.notification_type #=> String, one of "ALERT", "WARNING", "ANNOUNCEMENT", "INFORMATIONAL"
|
1681
|
+
# resp.managed_notification_events[0].aggregation_event_type #=> String, one of "AGGREGATE", "CHILD", "NONE"
|
1682
|
+
# resp.managed_notification_events[0].organizational_unit_id #=> String
|
1683
|
+
# resp.managed_notification_events[0].aggregation_summary.event_count #=> Integer
|
1684
|
+
# resp.managed_notification_events[0].aggregation_summary.aggregated_by #=> Array
|
1685
|
+
# resp.managed_notification_events[0].aggregation_summary.aggregated_by[0].name #=> String
|
1686
|
+
# resp.managed_notification_events[0].aggregation_summary.aggregated_by[0].value #=> String
|
1687
|
+
# resp.managed_notification_events[0].aggregation_summary.aggregated_accounts.name #=> String
|
1688
|
+
# resp.managed_notification_events[0].aggregation_summary.aggregated_accounts.count #=> Integer
|
1689
|
+
# resp.managed_notification_events[0].aggregation_summary.aggregated_accounts.sample_values #=> Array
|
1690
|
+
# resp.managed_notification_events[0].aggregation_summary.aggregated_accounts.sample_values[0] #=> String
|
1691
|
+
# resp.managed_notification_events[0].aggregation_summary.aggregated_regions.name #=> String
|
1692
|
+
# resp.managed_notification_events[0].aggregation_summary.aggregated_regions.count #=> Integer
|
1693
|
+
# resp.managed_notification_events[0].aggregation_summary.aggregated_regions.sample_values #=> Array
|
1694
|
+
# resp.managed_notification_events[0].aggregation_summary.aggregated_regions.sample_values[0] #=> String
|
1695
|
+
# resp.managed_notification_events[0].aggregation_summary.aggregated_organizational_units.name #=> String
|
1696
|
+
# resp.managed_notification_events[0].aggregation_summary.aggregated_organizational_units.count #=> Integer
|
1697
|
+
# resp.managed_notification_events[0].aggregation_summary.aggregated_organizational_units.sample_values #=> Array
|
1698
|
+
# resp.managed_notification_events[0].aggregation_summary.aggregated_organizational_units.sample_values[0] #=> String
|
1699
|
+
# resp.managed_notification_events[0].aggregation_summary.additional_summarization_dimensions #=> Array
|
1700
|
+
# resp.managed_notification_events[0].aggregation_summary.additional_summarization_dimensions[0].name #=> String
|
1701
|
+
# resp.managed_notification_events[0].aggregation_summary.additional_summarization_dimensions[0].count #=> Integer
|
1702
|
+
# resp.managed_notification_events[0].aggregation_summary.additional_summarization_dimensions[0].sample_values #=> Array
|
1703
|
+
# resp.managed_notification_events[0].aggregation_summary.additional_summarization_dimensions[0].sample_values[0] #=> String
|
1704
|
+
# resp.managed_notification_events[0].aggregated_notification_regions #=> Array
|
1705
|
+
# resp.managed_notification_events[0].aggregated_notification_regions[0] #=> String
|
1706
|
+
#
|
1707
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListManagedNotificationEvents AWS API Documentation
|
1708
|
+
#
|
1709
|
+
# @overload list_managed_notification_events(params = {})
|
1710
|
+
# @param [Hash] params ({})
|
1711
|
+
def list_managed_notification_events(params = {}, options = {})
|
1712
|
+
req = build_request(:list_managed_notification_events, params)
|
1713
|
+
req.send_request(options)
|
1714
|
+
end
|
1715
|
+
|
1716
|
+
# Returns a list of abbreviated `NotificationConfigurations` according
|
1717
|
+
# to specified filters, in reverse chronological order (newest first).
|
1023
1718
|
#
|
1024
1719
|
# @option params [String] :event_rule_source
|
1025
1720
|
# The matched event source.
|
1026
1721
|
#
|
1027
|
-
# Must match one of the valid EventBridge sources. Only
|
1028
|
-
# sourced events are supported. For example, `aws.ec2`
|
1029
|
-
# `aws.cloudwatch`. For more information, see [Event delivery from
|
1030
|
-
# services][1] in the *Amazon EventBridge User
|
1722
|
+
# Must match one of the valid EventBridge sources. Only Amazon Web
|
1723
|
+
# Services service sourced events are supported. For example, `aws.ec2`
|
1724
|
+
# and `aws.cloudwatch`. For more information, see [Event delivery from
|
1725
|
+
# Amazon Web Services services][1] in the *Amazon EventBridge User
|
1726
|
+
# Guide*.
|
1031
1727
|
#
|
1032
1728
|
#
|
1033
1729
|
#
|
@@ -1037,29 +1733,29 @@ module Aws::Notifications
|
|
1037
1733
|
# The Amazon Resource Name (ARN) of the Channel to match.
|
1038
1734
|
#
|
1039
1735
|
# @option params [String] :status
|
1040
|
-
# The NotificationConfiguration status to match.
|
1736
|
+
# The `NotificationConfiguration` status to match.
|
1041
1737
|
#
|
1042
1738
|
# * Values:
|
1043
1739
|
#
|
1044
1740
|
# * `ACTIVE`
|
1045
1741
|
#
|
1046
|
-
# * All EventRules are `ACTIVE` and any call can be run.
|
1742
|
+
# * All `EventRules` are `ACTIVE` and any call can be run.
|
1047
1743
|
#
|
1048
1744
|
# ^
|
1049
1745
|
# * `PARTIALLY_ACTIVE`
|
1050
1746
|
#
|
1051
|
-
# * Some EventRules are `ACTIVE` and some are `INACTIVE`. Any call
|
1747
|
+
# * Some `EventRules` are `ACTIVE` and some are `INACTIVE`. Any call
|
1052
1748
|
# can be run.
|
1053
1749
|
#
|
1054
1750
|
# * Any call can be run.
|
1055
1751
|
# * `INACTIVE`
|
1056
1752
|
#
|
1057
|
-
# * All EventRules are `INACTIVE` and any call can be run.
|
1753
|
+
# * All `EventRules` are `INACTIVE` and any call can be run.
|
1058
1754
|
#
|
1059
1755
|
# ^
|
1060
1756
|
# * `DELETING`
|
1061
1757
|
#
|
1062
|
-
# * This NotificationConfiguration is being deleted.
|
1758
|
+
# * This `NotificationConfiguration` is being deleted.
|
1063
1759
|
#
|
1064
1760
|
# * Only `GET` and `LIST` calls can be run.
|
1065
1761
|
#
|
@@ -1069,7 +1765,7 @@ module Aws::Notifications
|
|
1069
1765
|
#
|
1070
1766
|
# @option params [String] :next_token
|
1071
1767
|
# The start token for paginated calls. Retrieved from the response of a
|
1072
|
-
# previous ListEventRules call. Next token uses Base64 encoding.
|
1768
|
+
# previous `ListEventRules` call. Next token uses Base64 encoding.
|
1073
1769
|
#
|
1074
1770
|
# @return [Types::ListNotificationConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1075
1771
|
#
|
@@ -1108,7 +1804,7 @@ module Aws::Notifications
|
|
1108
1804
|
req.send_request(options)
|
1109
1805
|
end
|
1110
1806
|
|
1111
|
-
# Returns a list of NotificationEvents according to specified filters,
|
1807
|
+
# Returns a list of `NotificationEvents` according to specified filters,
|
1112
1808
|
# in reverse chronological order (newest first).
|
1113
1809
|
#
|
1114
1810
|
# User Notifications stores notifications in the individual Regions you
|
@@ -1118,7 +1814,7 @@ module Aws::Notifications
|
|
1118
1814
|
# backfill notifications to new Regions selected as notification hubs.
|
1119
1815
|
# For this reason, we recommend that you make calls in your oldest
|
1120
1816
|
# registered notification hub. For more information, see [Notification
|
1121
|
-
# hubs][1] in the *
|
1817
|
+
# hubs][1] in the *Amazon Web Services User Notifications User Guide*.
|
1122
1818
|
#
|
1123
1819
|
#
|
1124
1820
|
#
|
@@ -1132,15 +1828,16 @@ module Aws::Notifications
|
|
1132
1828
|
#
|
1133
1829
|
# @option params [String] :locale
|
1134
1830
|
# The locale code of the language used for the retrieved
|
1135
|
-
# NotificationEvent
|
1831
|
+
# `NotificationEvent`. The default locale is English `(en_US)`.
|
1136
1832
|
#
|
1137
1833
|
# @option params [String] :source
|
1138
1834
|
# The matched event source.
|
1139
1835
|
#
|
1140
|
-
# Must match one of the valid EventBridge sources. Only
|
1141
|
-
# sourced events are supported. For example, `aws.ec2`
|
1142
|
-
# `aws.cloudwatch`. For more information, see [Event delivery from
|
1143
|
-
# services][1] in the *Amazon EventBridge User
|
1836
|
+
# Must match one of the valid EventBridge sources. Only Amazon Web
|
1837
|
+
# Services service sourced events are supported. For example, `aws.ec2`
|
1838
|
+
# and `aws.cloudwatch`. For more information, see [Event delivery from
|
1839
|
+
# Amazon Web Services services][1] in the *Amazon EventBridge User
|
1840
|
+
# Guide*.
|
1144
1841
|
#
|
1145
1842
|
#
|
1146
1843
|
#
|
@@ -1150,7 +1847,7 @@ module Aws::Notifications
|
|
1150
1847
|
# Include aggregated child events in the result.
|
1151
1848
|
#
|
1152
1849
|
# @option params [String] :aggregate_notification_event_arn
|
1153
|
-
# The Amazon Resource Name (ARN) of the aggregatedNotificationEventArn
|
1850
|
+
# The Amazon Resource Name (ARN) of the `aggregatedNotificationEventArn`
|
1154
1851
|
# to match.
|
1155
1852
|
#
|
1156
1853
|
# @option params [Integer] :max_results
|
@@ -1159,7 +1856,7 @@ module Aws::Notifications
|
|
1159
1856
|
#
|
1160
1857
|
# @option params [String] :next_token
|
1161
1858
|
# The start token for paginated calls. Retrieved from the response of a
|
1162
|
-
# previous ListEventRules call. Next token uses Base64 encoding.
|
1859
|
+
# previous `ListEventRules` call. Next token uses Base64 encoding.
|
1163
1860
|
#
|
1164
1861
|
# @return [Types::ListNotificationEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1165
1862
|
#
|
@@ -1198,6 +1895,27 @@ module Aws::Notifications
|
|
1198
1895
|
# resp.notification_events[0].notification_event.notification_type #=> String, one of "ALERT", "WARNING", "ANNOUNCEMENT", "INFORMATIONAL"
|
1199
1896
|
# resp.notification_events[0].aggregation_event_type #=> String, one of "AGGREGATE", "CHILD", "NONE"
|
1200
1897
|
# resp.notification_events[0].aggregate_notification_event_arn #=> String
|
1898
|
+
# resp.notification_events[0].aggregation_summary.event_count #=> Integer
|
1899
|
+
# resp.notification_events[0].aggregation_summary.aggregated_by #=> Array
|
1900
|
+
# resp.notification_events[0].aggregation_summary.aggregated_by[0].name #=> String
|
1901
|
+
# resp.notification_events[0].aggregation_summary.aggregated_by[0].value #=> String
|
1902
|
+
# resp.notification_events[0].aggregation_summary.aggregated_accounts.name #=> String
|
1903
|
+
# resp.notification_events[0].aggregation_summary.aggregated_accounts.count #=> Integer
|
1904
|
+
# resp.notification_events[0].aggregation_summary.aggregated_accounts.sample_values #=> Array
|
1905
|
+
# resp.notification_events[0].aggregation_summary.aggregated_accounts.sample_values[0] #=> String
|
1906
|
+
# resp.notification_events[0].aggregation_summary.aggregated_regions.name #=> String
|
1907
|
+
# resp.notification_events[0].aggregation_summary.aggregated_regions.count #=> Integer
|
1908
|
+
# resp.notification_events[0].aggregation_summary.aggregated_regions.sample_values #=> Array
|
1909
|
+
# resp.notification_events[0].aggregation_summary.aggregated_regions.sample_values[0] #=> String
|
1910
|
+
# resp.notification_events[0].aggregation_summary.aggregated_organizational_units.name #=> String
|
1911
|
+
# resp.notification_events[0].aggregation_summary.aggregated_organizational_units.count #=> Integer
|
1912
|
+
# resp.notification_events[0].aggregation_summary.aggregated_organizational_units.sample_values #=> Array
|
1913
|
+
# resp.notification_events[0].aggregation_summary.aggregated_organizational_units.sample_values[0] #=> String
|
1914
|
+
# resp.notification_events[0].aggregation_summary.additional_summarization_dimensions #=> Array
|
1915
|
+
# resp.notification_events[0].aggregation_summary.additional_summarization_dimensions[0].name #=> String
|
1916
|
+
# resp.notification_events[0].aggregation_summary.additional_summarization_dimensions[0].count #=> Integer
|
1917
|
+
# resp.notification_events[0].aggregation_summary.additional_summarization_dimensions[0].sample_values #=> Array
|
1918
|
+
# resp.notification_events[0].aggregation_summary.additional_summarization_dimensions[0].sample_values[0] #=> String
|
1201
1919
|
#
|
1202
1920
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListNotificationEvents AWS API Documentation
|
1203
1921
|
#
|
@@ -1208,7 +1926,7 @@ module Aws::Notifications
|
|
1208
1926
|
req.send_request(options)
|
1209
1927
|
end
|
1210
1928
|
|
1211
|
-
# Returns a list of NotificationHubs
|
1929
|
+
# Returns a list of `NotificationHubs`.
|
1212
1930
|
#
|
1213
1931
|
# @option params [Integer] :max_results
|
1214
1932
|
# The maximum number of records to list in a single response.
|
@@ -1252,10 +1970,11 @@ module Aws::Notifications
|
|
1252
1970
|
|
1253
1971
|
# Returns a list of tags for a specified Amazon Resource Name (ARN).
|
1254
1972
|
#
|
1255
|
-
# For more information, see [Tagging your
|
1256
|
-
# *Tagging
|
1973
|
+
# For more information, see [Tagging your Amazon Web Services
|
1974
|
+
# resources][1] in the *Tagging Amazon Web Services Resources User
|
1975
|
+
# Guide*.
|
1257
1976
|
#
|
1258
|
-
# <note markdown="1"> This is only supported for NotificationConfigurations
|
1977
|
+
# <note markdown="1"> This is only supported for `NotificationConfigurations`.
|
1259
1978
|
#
|
1260
1979
|
# </note>
|
1261
1980
|
#
|
@@ -1290,13 +2009,13 @@ module Aws::Notifications
|
|
1290
2009
|
req.send_request(options)
|
1291
2010
|
end
|
1292
2011
|
|
1293
|
-
# Registers a
|
2012
|
+
# Registers a `NotificationConfiguration` in the specified Region.
|
1294
2013
|
#
|
1295
|
-
# There is a maximum of one
|
1296
|
-
# maximum of 3
|
2014
|
+
# There is a maximum of one `NotificationConfiguration` per Region. You
|
2015
|
+
# can have a maximum of 3 `NotificationHub` resources at a time.
|
1297
2016
|
#
|
1298
2017
|
# @option params [required, String] :notification_hub_region
|
1299
|
-
# The Region of the NotificationHub
|
2018
|
+
# The Region of the `NotificationHub`.
|
1300
2019
|
#
|
1301
2020
|
# @return [Types::RegisterNotificationHubResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1302
2021
|
#
|
@@ -1330,10 +2049,11 @@ module Aws::Notifications
|
|
1330
2049
|
|
1331
2050
|
# Tags the resource with a tag key and value.
|
1332
2051
|
#
|
1333
|
-
# For more information, see [Tagging your
|
1334
|
-
# *Tagging
|
2052
|
+
# For more information, see [Tagging your Amazon Web Services
|
2053
|
+
# resources][1] in the *Tagging Amazon Web Services Resources User
|
2054
|
+
# Guide*.
|
1335
2055
|
#
|
1336
|
-
# <note markdown="1"> This is only supported for NotificationConfigurations
|
2056
|
+
# <note markdown="1"> This is only supported for `NotificationConfigurations`.
|
1337
2057
|
#
|
1338
2058
|
# </note>
|
1339
2059
|
#
|
@@ -1370,8 +2090,9 @@ module Aws::Notifications
|
|
1370
2090
|
|
1371
2091
|
# Untags a resource with a specified Amazon Resource Name (ARN).
|
1372
2092
|
#
|
1373
|
-
# For more information, see [Tagging your
|
1374
|
-
# *Tagging
|
2093
|
+
# For more information, see [Tagging your Amazon Web Services
|
2094
|
+
# resources][1] in the *Tagging Amazon Web Services Resources User
|
2095
|
+
# Guide*.
|
1375
2096
|
#
|
1376
2097
|
#
|
1377
2098
|
#
|
@@ -1401,14 +2122,14 @@ module Aws::Notifications
|
|
1401
2122
|
req.send_request(options)
|
1402
2123
|
end
|
1403
2124
|
|
1404
|
-
# Updates an existing EventRule
|
2125
|
+
# Updates an existing `EventRule`.
|
1405
2126
|
#
|
1406
2127
|
# @option params [required, String] :arn
|
1407
|
-
# The Amazon Resource Name (ARN) to use to update the EventRule
|
2128
|
+
# The Amazon Resource Name (ARN) to use to update the `EventRule`.
|
1408
2129
|
#
|
1409
2130
|
# @option params [String] :event_pattern
|
1410
2131
|
# An additional event pattern used to further filter the events this
|
1411
|
-
# EventRule receives.
|
2132
|
+
# `EventRule` receives.
|
1412
2133
|
#
|
1413
2134
|
# For more information, see [Amazon EventBridge event patterns][1] in
|
1414
2135
|
# the *Amazon EventBridge User Guide.*
|
@@ -1418,7 +2139,8 @@ module Aws::Notifications
|
|
1418
2139
|
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html
|
1419
2140
|
#
|
1420
2141
|
# @option params [Array<String>] :regions
|
1421
|
-
# A list of
|
2142
|
+
# A list of Amazon Web Services Regions that sends events to this
|
2143
|
+
# `EventRule`.
|
1422
2144
|
#
|
1423
2145
|
# @return [Types::UpdateEventRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1424
2146
|
#
|
@@ -1451,47 +2173,38 @@ module Aws::Notifications
|
|
1451
2173
|
req.send_request(options)
|
1452
2174
|
end
|
1453
2175
|
|
1454
|
-
# Updates a NotificationConfiguration
|
2176
|
+
# Updates a `NotificationConfiguration`.
|
1455
2177
|
#
|
1456
2178
|
# @option params [required, String] :arn
|
1457
2179
|
# The Amazon Resource Name (ARN) used to update the
|
1458
|
-
# NotificationConfiguration
|
2180
|
+
# `NotificationConfiguration`.
|
1459
2181
|
#
|
1460
2182
|
# @option params [String] :name
|
1461
|
-
# The name of the NotificationConfiguration
|
2183
|
+
# The name of the `NotificationConfiguration`.
|
1462
2184
|
#
|
1463
2185
|
# @option params [String] :description
|
1464
|
-
# The description of the NotificationConfiguration
|
2186
|
+
# The description of the `NotificationConfiguration`.
|
1465
2187
|
#
|
1466
2188
|
# @option params [String] :aggregation_duration
|
1467
|
-
# The
|
1468
|
-
#
|
1469
|
-
# The status should always be `INACTIVE` when part of the
|
1470
|
-
# CreateNotificationConfiguration response.
|
2189
|
+
# The aggregation preference of the `NotificationConfiguration`.
|
1471
2190
|
#
|
1472
2191
|
# * Values:
|
1473
2192
|
#
|
1474
|
-
# * `
|
2193
|
+
# * `LONG`
|
1475
2194
|
#
|
1476
|
-
# *
|
2195
|
+
# * Aggregate notifications for long periods of time (12 hours).
|
1477
2196
|
#
|
1478
2197
|
# ^
|
1479
|
-
# * `
|
1480
|
-
#
|
1481
|
-
# * Some EventRules are `ACTIVE` and some are `INACTIVE`. Any call
|
1482
|
-
# can be run.
|
1483
|
-
#
|
1484
|
-
# * Any call can be run.
|
1485
|
-
# * `INACTIVE`
|
2198
|
+
# * `SHORT`
|
1486
2199
|
#
|
1487
|
-
# *
|
2200
|
+
# * Aggregate notifications for short periods of time (5 minutes).
|
1488
2201
|
#
|
1489
2202
|
# ^
|
1490
|
-
# * `
|
2203
|
+
# * `NONE`
|
1491
2204
|
#
|
1492
|
-
# *
|
2205
|
+
# * Don't aggregate notifications.
|
1493
2206
|
#
|
1494
|
-
#
|
2207
|
+
# ^
|
1495
2208
|
#
|
1496
2209
|
# @return [Types::UpdateNotificationConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1497
2210
|
#
|
@@ -1537,7 +2250,7 @@ module Aws::Notifications
|
|
1537
2250
|
tracer: tracer
|
1538
2251
|
)
|
1539
2252
|
context[:gem_name] = 'aws-sdk-notifications'
|
1540
|
-
context[:gem_version] = '1.
|
2253
|
+
context[:gem_version] = '1.2.0'
|
1541
2254
|
Seahorse::Client::Request.new(handlers, context)
|
1542
2255
|
end
|
1543
2256
|
|