aws-sdk-ssmcontacts 1.5.0 → 1.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ssmcontacts/client.rb +704 -6
- data/lib/aws-sdk-ssmcontacts/types.rb +10 -10
- data/lib/aws-sdk-ssmcontacts.rb +1 -1
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f0902c86253ae3633f855d0575589fb0463a28b49ef2836439ae302e7346a8a4
|
4
|
+
data.tar.gz: ba75a080ea06ff84eec02d98c12e1a1703196106d45180bfd315e589a7aa44eb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: aa54a2cd5d3f48d2554772296b9be569e330c14b677aa05f3f5c5db0f12c040c6df837f62efd6f91beb262d4e5461cf61afeab9f0d90b00e1e83a0d4e44398bd
|
7
|
+
data.tar.gz: 4c634aa0eaec6d9bd43adbc42122bac64f78950c696638b3dcfcd0ba7db09cd2f3d66d716762d7d77fc04e5756a9cf81f02b4105b9d2aa84ab96b8978424ca3a
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.9.0 (2021-11-04)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.8.0 (2021-10-18)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.7.0 (2021-09-07)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Added SDK examples for SSM-Contacts.
|
18
|
+
|
19
|
+
1.6.0 (2021-09-01)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.5.0 (2021-08-02)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.9.0
|
@@ -285,6 +285,15 @@ module Aws::SSMContacts
|
|
285
285
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
286
286
|
# requests are made, and retries are disabled.
|
287
287
|
#
|
288
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
289
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
290
|
+
# will be used if available.
|
291
|
+
#
|
292
|
+
# @option options [Boolean] :use_fips_endpoint
|
293
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
294
|
+
# When a `fips` region is used, the region is normalized and this config
|
295
|
+
# is set to `true`.
|
296
|
+
#
|
288
297
|
# @option options [Boolean] :validate_params (true)
|
289
298
|
# When `true`, request parameters are validated before
|
290
299
|
# sending the request.
|
@@ -369,6 +378,21 @@ module Aws::SSMContacts
|
|
369
378
|
#
|
370
379
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
371
380
|
#
|
381
|
+
#
|
382
|
+
# @example Example: To accept a page during and engagement
|
383
|
+
#
|
384
|
+
# # The following accept-page operation uses an accept code sent to the contact channel to accept a page.
|
385
|
+
#
|
386
|
+
# resp = client.accept_page({
|
387
|
+
# accept_code: "425440",
|
388
|
+
# accept_type: "READ",
|
389
|
+
# page_id: "arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3",
|
390
|
+
# })
|
391
|
+
#
|
392
|
+
# resp.to_h outputs the following:
|
393
|
+
# {
|
394
|
+
# }
|
395
|
+
#
|
372
396
|
# @example Request syntax with placeholder values
|
373
397
|
#
|
374
398
|
# resp = client.accept_page({
|
@@ -401,6 +425,20 @@ module Aws::SSMContacts
|
|
401
425
|
#
|
402
426
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
403
427
|
#
|
428
|
+
#
|
429
|
+
# @example Example: Activate a contact's contact channel
|
430
|
+
#
|
431
|
+
# # The following activate-contact-channel example activates a contact channel and makes it usable as part of an incident.
|
432
|
+
#
|
433
|
+
# resp = client.activate_contact_channel({
|
434
|
+
# activation_code: "466136",
|
435
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
436
|
+
# })
|
437
|
+
#
|
438
|
+
# resp.to_h outputs the following:
|
439
|
+
# {
|
440
|
+
# }
|
441
|
+
#
|
404
442
|
# @example Request syntax with placeholder values
|
405
443
|
#
|
406
444
|
# resp = client.activate_contact_channel({
|
@@ -442,7 +480,7 @@ module Aws::SSMContacts
|
|
442
480
|
# first Region of your replication set.
|
443
481
|
#
|
444
482
|
# @option params [String] :idempotency_token
|
445
|
-
# A token ensuring that the
|
483
|
+
# A token ensuring that the operation is called only once with the
|
446
484
|
# specified details.
|
447
485
|
#
|
448
486
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -452,6 +490,28 @@ module Aws::SSMContacts
|
|
452
490
|
#
|
453
491
|
# * {Types::CreateContactResult#contact_arn #contact_arn} => String
|
454
492
|
#
|
493
|
+
#
|
494
|
+
# @example Example: To create a contact
|
495
|
+
#
|
496
|
+
# # The following create-contact example creates a contact in your environment with a blank plan. The plan can be updated
|
497
|
+
# # after creating contact channels. Use the create-contact-channel operation with the output ARN of this command. After you
|
498
|
+
# # have created contact channels for this contact use update-contact to update the plan.
|
499
|
+
#
|
500
|
+
# resp = client.create_contact({
|
501
|
+
# alias: "akuam",
|
502
|
+
# display_name: "Akua Mansa",
|
503
|
+
# plan: {
|
504
|
+
# stages: [
|
505
|
+
# ],
|
506
|
+
# },
|
507
|
+
# type: "PERSONAL",
|
508
|
+
# })
|
509
|
+
#
|
510
|
+
# resp.to_h outputs the following:
|
511
|
+
# {
|
512
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
513
|
+
# }
|
514
|
+
#
|
455
515
|
# @example Request syntax with placeholder values
|
456
516
|
#
|
457
517
|
# resp = client.create_contact({
|
@@ -535,7 +595,7 @@ module Aws::SSMContacts
|
|
535
595
|
# until it has been activated.
|
536
596
|
#
|
537
597
|
# @option params [String] :idempotency_token
|
538
|
-
# A token ensuring that the
|
598
|
+
# A token ensuring that the operation is called only once with the
|
539
599
|
# specified details.
|
540
600
|
#
|
541
601
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -545,6 +605,26 @@ module Aws::SSMContacts
|
|
545
605
|
#
|
546
606
|
# * {Types::CreateContactChannelResult#contact_channel_arn #contact_channel_arn} => String
|
547
607
|
#
|
608
|
+
#
|
609
|
+
# @example Example: To create a contact channel
|
610
|
+
#
|
611
|
+
# # Creates a contact channel of type SMS for the contact Akua Mansa. Contact channels can be created of type SMS, EMAIL, or
|
612
|
+
# # VOICE.
|
613
|
+
#
|
614
|
+
# resp = client.create_contact_channel({
|
615
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
616
|
+
# delivery_address: {
|
617
|
+
# simple_address: "+15005550199",
|
618
|
+
# },
|
619
|
+
# name: "akuas sms-test",
|
620
|
+
# type: "SMS",
|
621
|
+
# })
|
622
|
+
#
|
623
|
+
# resp.to_h outputs the following:
|
624
|
+
# {
|
625
|
+
# contact_channel_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/02f506b9-ea5d-4764-af89-2daa793ff024",
|
626
|
+
# }
|
627
|
+
#
|
548
628
|
# @example Request syntax with placeholder values
|
549
629
|
#
|
550
630
|
# resp = client.create_contact_channel({
|
@@ -580,6 +660,21 @@ module Aws::SSMContacts
|
|
580
660
|
#
|
581
661
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
582
662
|
#
|
663
|
+
#
|
664
|
+
# @example Example: To deactivate a contact channel
|
665
|
+
#
|
666
|
+
# # The following ``deactivate-contact-channel`` example deactivates a contact channel. Deactivating a contact channel means
|
667
|
+
# # the contact channel will no longer be paged during an incident. You can also reactivate a contact channel at any time
|
668
|
+
# # using the activate-contact-channel operation.
|
669
|
+
#
|
670
|
+
# resp = client.deactivate_contact_channel({
|
671
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
672
|
+
# })
|
673
|
+
#
|
674
|
+
# resp.to_h outputs the following:
|
675
|
+
# {
|
676
|
+
# }
|
677
|
+
#
|
583
678
|
# @example Request syntax with placeholder values
|
584
679
|
#
|
585
680
|
# resp = client.deactivate_contact_channel({
|
@@ -606,6 +701,20 @@ module Aws::SSMContacts
|
|
606
701
|
#
|
607
702
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
608
703
|
#
|
704
|
+
#
|
705
|
+
# @example Example: To delete a contact
|
706
|
+
#
|
707
|
+
# # The following delete-contact example deletes a contact. The contact will no longer be reachable from any escalation plan
|
708
|
+
# # that refers to them.
|
709
|
+
#
|
710
|
+
# resp = client.delete_contact({
|
711
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr",
|
712
|
+
# })
|
713
|
+
#
|
714
|
+
# resp.to_h outputs the following:
|
715
|
+
# {
|
716
|
+
# }
|
717
|
+
#
|
609
718
|
# @example Request syntax with placeholder values
|
610
719
|
#
|
611
720
|
# resp = client.delete_contact({
|
@@ -632,6 +741,20 @@ module Aws::SSMContacts
|
|
632
741
|
#
|
633
742
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
634
743
|
#
|
744
|
+
#
|
745
|
+
# @example Example: To delete a contact channel
|
746
|
+
#
|
747
|
+
# # The following delete-contact-channel example deletes a contact channel. Deleting a contact channel ensures the contact
|
748
|
+
# # channel will not be paged during an incident.
|
749
|
+
#
|
750
|
+
# resp = client.delete_contact_channel({
|
751
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/13149bad-52ee-45ea-ae1e-45857f78f9b2",
|
752
|
+
# })
|
753
|
+
#
|
754
|
+
# resp.to_h outputs the following:
|
755
|
+
# {
|
756
|
+
# }
|
757
|
+
#
|
635
758
|
# @example Request syntax with placeholder values
|
636
759
|
#
|
637
760
|
# resp = client.delete_contact_channel({
|
@@ -668,6 +791,28 @@ module Aws::SSMContacts
|
|
668
791
|
# * {Types::DescribeEngagementResult#start_time #start_time} => Time
|
669
792
|
# * {Types::DescribeEngagementResult#stop_time #stop_time} => Time
|
670
793
|
#
|
794
|
+
#
|
795
|
+
# @example Example: To describe the details of an engagement
|
796
|
+
#
|
797
|
+
# # The following describe-engagement example lists the details of an engagement to a contact or escalation plan. The
|
798
|
+
# # subject and content are sent to the contact channels.
|
799
|
+
#
|
800
|
+
# resp = client.describe_engagement({
|
801
|
+
# engagement_id: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356",
|
802
|
+
# })
|
803
|
+
#
|
804
|
+
# resp.to_h outputs the following:
|
805
|
+
# {
|
806
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
|
807
|
+
# content: "Testing engagements",
|
808
|
+
# engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356",
|
809
|
+
# public_content: "Testing engagements",
|
810
|
+
# public_subject: "test",
|
811
|
+
# sender: "tester",
|
812
|
+
# start_time: Time.parse("$2021-05-18T18:25:41.151000+00:00"),
|
813
|
+
# subject: "test",
|
814
|
+
# }
|
815
|
+
#
|
671
816
|
# @example Request syntax with placeholder values
|
672
817
|
#
|
673
818
|
# resp = client.describe_engagement({
|
@@ -716,6 +861,31 @@ module Aws::SSMContacts
|
|
716
861
|
# * {Types::DescribePageResult#read_time #read_time} => Time
|
717
862
|
# * {Types::DescribePageResult#delivery_time #delivery_time} => Time
|
718
863
|
#
|
864
|
+
#
|
865
|
+
# @example Example: To list the details of a page to a contact channel
|
866
|
+
#
|
867
|
+
# # The following describe-page example lists details of a page to a contact channel. The page will include the subject and
|
868
|
+
# # content provided.
|
869
|
+
#
|
870
|
+
# resp = client.describe_page({
|
871
|
+
# page_id: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93",
|
872
|
+
# })
|
873
|
+
#
|
874
|
+
# resp.to_h outputs the following:
|
875
|
+
# {
|
876
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
877
|
+
# content: "Testing engagements",
|
878
|
+
# delivery_time: Time.parse("2021-05-18T18:43:55.265000+00:00"),
|
879
|
+
# engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
|
880
|
+
# page_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93",
|
881
|
+
# public_content: "Testing engagements",
|
882
|
+
# public_subject: "test",
|
883
|
+
# read_time: Time.parse("2021-05-18T18:43:55.708000+00:00"),
|
884
|
+
# sender: "tester",
|
885
|
+
# sent_time: Time.parse("2021-05-18T18:43:29.301000+00:00"),
|
886
|
+
# subject: "test",
|
887
|
+
# }
|
888
|
+
#
|
719
889
|
# @example Request syntax with placeholder values
|
720
890
|
#
|
721
891
|
# resp = client.describe_page({
|
@@ -759,6 +929,113 @@ module Aws::SSMContacts
|
|
759
929
|
# * {Types::GetContactResult#type #type} => String
|
760
930
|
# * {Types::GetContactResult#plan #plan} => Types::Plan
|
761
931
|
#
|
932
|
+
#
|
933
|
+
# @example Example: Example 1: To describe a contact plan
|
934
|
+
#
|
935
|
+
# # The following get-contact example describes a contact.
|
936
|
+
#
|
937
|
+
# resp = client.get_contact({
|
938
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
939
|
+
# })
|
940
|
+
#
|
941
|
+
# resp.to_h outputs the following:
|
942
|
+
# {
|
943
|
+
# alias: "akuam",
|
944
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
945
|
+
# display_name: "Akua Mansa",
|
946
|
+
# plan: {
|
947
|
+
# stages: [
|
948
|
+
# {
|
949
|
+
# duration_in_minutes: 5,
|
950
|
+
# targets: [
|
951
|
+
# {
|
952
|
+
# channel_target_info: {
|
953
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65",
|
954
|
+
# retry_interval_in_minutes: 1,
|
955
|
+
# },
|
956
|
+
# },
|
957
|
+
# ],
|
958
|
+
# },
|
959
|
+
# {
|
960
|
+
# duration_in_minutes: 5,
|
961
|
+
# targets: [
|
962
|
+
# {
|
963
|
+
# channel_target_info: {
|
964
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad",
|
965
|
+
# retry_interval_in_minutes: 1,
|
966
|
+
# },
|
967
|
+
# },
|
968
|
+
# ],
|
969
|
+
# },
|
970
|
+
# {
|
971
|
+
# duration_in_minutes: 5,
|
972
|
+
# targets: [
|
973
|
+
# {
|
974
|
+
# channel_target_info: {
|
975
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a",
|
976
|
+
# retry_interval_in_minutes: 1,
|
977
|
+
# },
|
978
|
+
# },
|
979
|
+
# ],
|
980
|
+
# },
|
981
|
+
# ],
|
982
|
+
# },
|
983
|
+
# type: "PERSONAL",
|
984
|
+
# }
|
985
|
+
#
|
986
|
+
# @example Example: Example 2: To describe an escalation plan
|
987
|
+
#
|
988
|
+
# # The following get-contact example describes an escalation plan.
|
989
|
+
#
|
990
|
+
# resp = client.get_contact({
|
991
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
|
992
|
+
# })
|
993
|
+
#
|
994
|
+
# resp.to_h outputs the following:
|
995
|
+
# {
|
996
|
+
# alias: "example_escalation",
|
997
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
|
998
|
+
# display_name: "Example Escalation Plan",
|
999
|
+
# plan: {
|
1000
|
+
# stages: [
|
1001
|
+
# {
|
1002
|
+
# duration_in_minutes: 5,
|
1003
|
+
# targets: [
|
1004
|
+
# {
|
1005
|
+
# contact_target_info: {
|
1006
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1007
|
+
# is_essential: true,
|
1008
|
+
# },
|
1009
|
+
# },
|
1010
|
+
# ],
|
1011
|
+
# },
|
1012
|
+
# {
|
1013
|
+
# duration_in_minutes: 5,
|
1014
|
+
# targets: [
|
1015
|
+
# {
|
1016
|
+
# contact_target_info: {
|
1017
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr",
|
1018
|
+
# is_essential: false,
|
1019
|
+
# },
|
1020
|
+
# },
|
1021
|
+
# ],
|
1022
|
+
# },
|
1023
|
+
# {
|
1024
|
+
# duration_in_minutes: 0,
|
1025
|
+
# targets: [
|
1026
|
+
# {
|
1027
|
+
# contact_target_info: {
|
1028
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi",
|
1029
|
+
# is_essential: false,
|
1030
|
+
# },
|
1031
|
+
# },
|
1032
|
+
# ],
|
1033
|
+
# },
|
1034
|
+
# ],
|
1035
|
+
# },
|
1036
|
+
# type: "ESCALATION",
|
1037
|
+
# }
|
1038
|
+
#
|
762
1039
|
# @example Request syntax with placeholder values
|
763
1040
|
#
|
764
1041
|
# resp = client.get_contact({
|
@@ -803,6 +1080,27 @@ module Aws::SSMContacts
|
|
803
1080
|
# * {Types::GetContactChannelResult#delivery_address #delivery_address} => Types::ContactChannelAddress
|
804
1081
|
# * {Types::GetContactChannelResult#activation_status #activation_status} => String
|
805
1082
|
#
|
1083
|
+
#
|
1084
|
+
# @example Example: To list the details of a contact channel
|
1085
|
+
#
|
1086
|
+
# # The following get-contact-channel example lists the details of a contact channel.
|
1087
|
+
#
|
1088
|
+
# resp = client.get_contact_channel({
|
1089
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
1090
|
+
# })
|
1091
|
+
#
|
1092
|
+
# resp.to_h outputs the following:
|
1093
|
+
# {
|
1094
|
+
# activation_status: "ACTIVATED",
|
1095
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1096
|
+
# contact_channel_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
1097
|
+
# delivery_address: {
|
1098
|
+
# simple_address: "+15005550199",
|
1099
|
+
# },
|
1100
|
+
# name: "akuas sms",
|
1101
|
+
# type: "SMS",
|
1102
|
+
# }
|
1103
|
+
#
|
806
1104
|
# @example Request syntax with placeholder values
|
807
1105
|
#
|
808
1106
|
# resp = client.get_contact_channel({
|
@@ -838,6 +1136,21 @@ module Aws::SSMContacts
|
|
838
1136
|
# * {Types::GetContactPolicyResult#contact_arn #contact_arn} => String
|
839
1137
|
# * {Types::GetContactPolicyResult#policy #policy} => String
|
840
1138
|
#
|
1139
|
+
#
|
1140
|
+
# @example Example: To list the resource policies of a contact
|
1141
|
+
#
|
1142
|
+
# # The following get-contact-policy example lists the resource policies associated with the specified contact.
|
1143
|
+
#
|
1144
|
+
# resp = client.get_contact_policy({
|
1145
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
1146
|
+
# })
|
1147
|
+
#
|
1148
|
+
# resp.to_h outputs the following:
|
1149
|
+
# {
|
1150
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
1151
|
+
# policy: "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"SharePolicyForDocumentationDralia\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"222233334444\"},\"Action\":[\"ssm-contacts:GetContact\",\"ssm-contacts:StartEngagement\",\"ssm-contacts:DescribeEngagement\",\"ssm-contacts:ListPagesByEngagement\",\"ssm-contacts:StopEngagement\"],\"Resource\":[\"arn:aws:ssm-contacts:*:111122223333:contact/akuam\",\"arn:aws:ssm-contacts:*:111122223333:engagement/akuam/*\"]}]}",
|
1152
|
+
# }
|
1153
|
+
#
|
841
1154
|
# @example Request syntax with placeholder values
|
842
1155
|
#
|
843
1156
|
# resp = client.get_contact_policy({
|
@@ -876,6 +1189,31 @@ module Aws::SSMContacts
|
|
876
1189
|
#
|
877
1190
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
878
1191
|
#
|
1192
|
+
#
|
1193
|
+
# @example Example: To list the contact channels of a contact
|
1194
|
+
#
|
1195
|
+
# # The following list-contact-channels example lists the available contact channels of the specified contact.
|
1196
|
+
#
|
1197
|
+
# resp = client.list_contact_channels({
|
1198
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1199
|
+
# })
|
1200
|
+
#
|
1201
|
+
# resp.to_h outputs the following:
|
1202
|
+
# {
|
1203
|
+
# contact_channels: [
|
1204
|
+
# {
|
1205
|
+
# activation_status: "ACTIVATED",
|
1206
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1207
|
+
# contact_channel_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
1208
|
+
# delivery_address: {
|
1209
|
+
# simple_address: "+15005550100",
|
1210
|
+
# },
|
1211
|
+
# name: "akuas sms",
|
1212
|
+
# type: "SMS",
|
1213
|
+
# },
|
1214
|
+
# ],
|
1215
|
+
# }
|
1216
|
+
#
|
879
1217
|
# @example Request syntax with placeholder values
|
880
1218
|
#
|
881
1219
|
# resp = client.list_contact_channels({
|
@@ -928,6 +1266,44 @@ module Aws::SSMContacts
|
|
928
1266
|
#
|
929
1267
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
930
1268
|
#
|
1269
|
+
#
|
1270
|
+
# @example Example: To list all escalation plans and contacts
|
1271
|
+
#
|
1272
|
+
# # The following list-contacts example lists the contacts and escalation plans in your account.
|
1273
|
+
#
|
1274
|
+
# resp = client.list_contacts({
|
1275
|
+
# })
|
1276
|
+
#
|
1277
|
+
# resp.to_h outputs the following:
|
1278
|
+
# {
|
1279
|
+
# contacts: [
|
1280
|
+
# {
|
1281
|
+
# alias: "akuam",
|
1282
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1283
|
+
# display_name: "Akua Mansa",
|
1284
|
+
# type: "PERSONAL",
|
1285
|
+
# },
|
1286
|
+
# {
|
1287
|
+
# alias: "alejr",
|
1288
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr",
|
1289
|
+
# display_name: "Alejandro Rosalez",
|
1290
|
+
# type: "PERSONAL",
|
1291
|
+
# },
|
1292
|
+
# {
|
1293
|
+
# alias: "anasi",
|
1294
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi",
|
1295
|
+
# display_name: "Ana Carolina Silva",
|
1296
|
+
# type: "PERSONAL",
|
1297
|
+
# },
|
1298
|
+
# {
|
1299
|
+
# alias: "example_escalation",
|
1300
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
|
1301
|
+
# display_name: "Example Escalation",
|
1302
|
+
# type: "ESCALATION",
|
1303
|
+
# },
|
1304
|
+
# ],
|
1305
|
+
# }
|
1306
|
+
#
|
931
1307
|
# @example Request syntax with placeholder values
|
932
1308
|
#
|
933
1309
|
# resp = client.list_contacts({
|
@@ -977,6 +1353,45 @@ module Aws::SSMContacts
|
|
977
1353
|
#
|
978
1354
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
979
1355
|
#
|
1356
|
+
#
|
1357
|
+
# @example Example: To list all engagements
|
1358
|
+
#
|
1359
|
+
# # The following list-engagements example lists engagements to escalation plans and contacts. You can also list engagements
|
1360
|
+
# # for a single incident.
|
1361
|
+
#
|
1362
|
+
# resp = client.list_engagements({
|
1363
|
+
# })
|
1364
|
+
#
|
1365
|
+
# resp.to_h outputs the following:
|
1366
|
+
# {
|
1367
|
+
# engagements: [
|
1368
|
+
# {
|
1369
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1370
|
+
# engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/91792571-0b53-4821-9f73-d25d13d9e529",
|
1371
|
+
# sender: "cli",
|
1372
|
+
# start_time: Time.parse("2021-05-18T20:37:50.300000+00:00"),
|
1373
|
+
# },
|
1374
|
+
# {
|
1375
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1376
|
+
# engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
|
1377
|
+
# sender: "cli",
|
1378
|
+
# start_time: Time.parse("2021-05-18T18:40:26.666000+00:00"),
|
1379
|
+
# },
|
1380
|
+
# {
|
1381
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
|
1382
|
+
# engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356",
|
1383
|
+
# sender: "cli",
|
1384
|
+
# start_time: Time.parse("2021-05-18T18:25:41.151000+00:00"),
|
1385
|
+
# },
|
1386
|
+
# {
|
1387
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1388
|
+
# engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f",
|
1389
|
+
# sender: "cli",
|
1390
|
+
# start_time: Time.parse("2021-05-18T18:20:58.093000+00:00"),
|
1391
|
+
# },
|
1392
|
+
# ],
|
1393
|
+
# }
|
1394
|
+
#
|
980
1395
|
# @example Request syntax with placeholder values
|
981
1396
|
#
|
982
1397
|
# resp = client.list_engagements({
|
@@ -1029,6 +1444,39 @@ module Aws::SSMContacts
|
|
1029
1444
|
#
|
1030
1445
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1031
1446
|
#
|
1447
|
+
#
|
1448
|
+
# @example Example: To list page receipts
|
1449
|
+
#
|
1450
|
+
# # The following command-name example lists whether a page was received or not by a contact.
|
1451
|
+
#
|
1452
|
+
# resp = client.list_page_receipts({
|
1453
|
+
# page_id: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3",
|
1454
|
+
# })
|
1455
|
+
#
|
1456
|
+
# resp.to_h outputs the following:
|
1457
|
+
# {
|
1458
|
+
# receipts: [
|
1459
|
+
# {
|
1460
|
+
# contact_channel_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
1461
|
+
# receipt_info: "425440",
|
1462
|
+
# receipt_time: Time.parse("2021-05-18T20:42:57.485000+00:00"),
|
1463
|
+
# receipt_type: "DELIVERED",
|
1464
|
+
# },
|
1465
|
+
# {
|
1466
|
+
# contact_channel_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
1467
|
+
# receipt_info: "425440",
|
1468
|
+
# receipt_time: Time.parse("2021-05-18T20:42:57.907000+00:00"),
|
1469
|
+
# receipt_type: "READ",
|
1470
|
+
# },
|
1471
|
+
# {
|
1472
|
+
# contact_channel_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
1473
|
+
# receipt_info: "SM6656c19132f1465f9c9c1123a5dde7c9",
|
1474
|
+
# receipt_time: Time.parse("2021-05-18T20:40:52.962000+00:00"),
|
1475
|
+
# receipt_type: "SENT",
|
1476
|
+
# },
|
1477
|
+
# ],
|
1478
|
+
# }
|
1479
|
+
#
|
1032
1480
|
# @example Request syntax with placeholder values
|
1033
1481
|
#
|
1034
1482
|
# resp = client.list_page_receipts({
|
@@ -1075,6 +1523,30 @@ module Aws::SSMContacts
|
|
1075
1523
|
#
|
1076
1524
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1077
1525
|
#
|
1526
|
+
#
|
1527
|
+
# @example Example: To list pages by contact
|
1528
|
+
#
|
1529
|
+
# # The following list-pages-by-contact example lists all pages to the specified contact.
|
1530
|
+
#
|
1531
|
+
# resp = client.list_pages_by_contact({
|
1532
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1533
|
+
# })
|
1534
|
+
#
|
1535
|
+
# resp.to_h outputs the following:
|
1536
|
+
# {
|
1537
|
+
# pages: [
|
1538
|
+
# {
|
1539
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1540
|
+
# delivery_time: Time.parse("2021-05-18T18:43:55.265000+00:00"),
|
1541
|
+
# engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
|
1542
|
+
# page_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93",
|
1543
|
+
# read_time: Time.parse("2021-05-18T18:43:55.708000+00:00"),
|
1544
|
+
# sender: "cli",
|
1545
|
+
# sent_time: Time.parse("2021-05-18T18:43:29.301000+00:00"),
|
1546
|
+
# },
|
1547
|
+
# ],
|
1548
|
+
# }
|
1549
|
+
#
|
1078
1550
|
# @example Request syntax with placeholder values
|
1079
1551
|
#
|
1080
1552
|
# resp = client.list_pages_by_contact({
|
@@ -1125,6 +1597,28 @@ module Aws::SSMContacts
|
|
1125
1597
|
#
|
1126
1598
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1127
1599
|
#
|
1600
|
+
#
|
1601
|
+
# @example Example: To list pages to contact channels started from an engagement.
|
1602
|
+
#
|
1603
|
+
# # The following list-pages-by-engagement example lists the pages that occurred while engaging the defined engagement plan.
|
1604
|
+
#
|
1605
|
+
# resp = client.list_pages_by_engagement({
|
1606
|
+
# engagement_id: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
|
1607
|
+
# })
|
1608
|
+
#
|
1609
|
+
# resp.to_h outputs the following:
|
1610
|
+
# {
|
1611
|
+
# pages: [
|
1612
|
+
# {
|
1613
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1614
|
+
# engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
|
1615
|
+
# page_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93",
|
1616
|
+
# sender: "cli",
|
1617
|
+
# sent_time: Time.parse("2021-05-18T18:40:27.245000+00:00"),
|
1618
|
+
# },
|
1619
|
+
# ],
|
1620
|
+
# }
|
1621
|
+
#
|
1128
1622
|
# @example Request syntax with placeholder values
|
1129
1623
|
#
|
1130
1624
|
# resp = client.list_pages_by_engagement({
|
@@ -1164,6 +1658,25 @@ module Aws::SSMContacts
|
|
1164
1658
|
#
|
1165
1659
|
# * {Types::ListTagsForResourceResult#tags #tags} => Array<Types::Tag>
|
1166
1660
|
#
|
1661
|
+
#
|
1662
|
+
# @example Example: To list tags for a contact
|
1663
|
+
#
|
1664
|
+
# # The following list-tags-for-resource example lists the tags of the specified contact.
|
1665
|
+
#
|
1666
|
+
# resp = client.list_tags_for_resource({
|
1667
|
+
# resource_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
1668
|
+
# })
|
1669
|
+
#
|
1670
|
+
# resp.to_h outputs the following:
|
1671
|
+
# {
|
1672
|
+
# tags: [
|
1673
|
+
# {
|
1674
|
+
# key: "group1",
|
1675
|
+
# value: "1",
|
1676
|
+
# },
|
1677
|
+
# ],
|
1678
|
+
# }
|
1679
|
+
#
|
1167
1680
|
# @example Request syntax with placeholder values
|
1168
1681
|
#
|
1169
1682
|
# resp = client.list_tags_for_resource({
|
@@ -1195,6 +1708,21 @@ module Aws::SSMContacts
|
|
1195
1708
|
#
|
1196
1709
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1197
1710
|
#
|
1711
|
+
#
|
1712
|
+
# @example Example: To share a contact and engagements
|
1713
|
+
#
|
1714
|
+
# # The following put-contact-policy example adds a resource policy to the contact Akua that shares the contact and related
|
1715
|
+
# # engagements with the principal.
|
1716
|
+
#
|
1717
|
+
# resp = client.put_contact_policy({
|
1718
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
1719
|
+
# policy: "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"ExampleResourcePolicy\",\"Action\":[\"ssm-contacts:GetContact\",\"ssm-contacts:StartEngagement\",\"ssm-contacts:DescribeEngagement\",\"ssm-contacts:ListPagesByEngagement\",\"ssm-contacts:StopEngagement\"],\"Principal\":{\"AWS\":\"222233334444\"},\"Effect\":\"Allow\",\"Resource\":[\"arn:aws:ssm-contacts:*:111122223333:contact/akuam\",\"arn:aws:ssm-contacts:*:111122223333:engagement/akuam/*\"]}]}",
|
1720
|
+
# })
|
1721
|
+
#
|
1722
|
+
# resp.to_h outputs the following:
|
1723
|
+
# {
|
1724
|
+
# }
|
1725
|
+
#
|
1198
1726
|
# @example Request syntax with placeholder values
|
1199
1727
|
#
|
1200
1728
|
# resp = client.put_contact_policy({
|
@@ -1213,7 +1741,7 @@ module Aws::SSMContacts
|
|
1213
1741
|
|
1214
1742
|
# Sends an activation code to a contact channel. The contact can use
|
1215
1743
|
# this code to activate the contact channel in the console or with the
|
1216
|
-
# `ActivateChannel`
|
1744
|
+
# `ActivateChannel` operation. Incident Manager can't engage a contact
|
1217
1745
|
# channel until it has been activated.
|
1218
1746
|
#
|
1219
1747
|
# @option params [required, String] :contact_channel_id
|
@@ -1221,6 +1749,19 @@ module Aws::SSMContacts
|
|
1221
1749
|
#
|
1222
1750
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1223
1751
|
#
|
1752
|
+
#
|
1753
|
+
# @example Example: To send an activation code
|
1754
|
+
#
|
1755
|
+
# # The following send-activation-code example sends an activation code and message to the specified contact channel.
|
1756
|
+
#
|
1757
|
+
# resp = client.send_activation_code({
|
1758
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/8ddae2d1-12c8-4e45-b852-c8587266c400",
|
1759
|
+
# })
|
1760
|
+
#
|
1761
|
+
# resp.to_h outputs the following:
|
1762
|
+
# {
|
1763
|
+
# }
|
1764
|
+
#
|
1224
1765
|
# @example Request syntax with placeholder values
|
1225
1766
|
#
|
1226
1767
|
# resp = client.send_activation_code({
|
@@ -1265,7 +1806,7 @@ module Aws::SSMContacts
|
|
1265
1806
|
# The ARN of the incident that the engagement is part of.
|
1266
1807
|
#
|
1267
1808
|
# @option params [String] :idempotency_token
|
1268
|
-
# A token ensuring that the
|
1809
|
+
# A token ensuring that the operation is called only once with the
|
1269
1810
|
# specified details.
|
1270
1811
|
#
|
1271
1812
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -1275,6 +1816,47 @@ module Aws::SSMContacts
|
|
1275
1816
|
#
|
1276
1817
|
# * {Types::StartEngagementResult#engagement_arn #engagement_arn} => String
|
1277
1818
|
#
|
1819
|
+
#
|
1820
|
+
# @example Example: Example 1: To page a contact's contact channels
|
1821
|
+
#
|
1822
|
+
# # The following start-engagement pages contact's contact channels. Sender, subject, public-subject, and public-content are
|
1823
|
+
# # all free from fields. Incident Manager sends the subject and content to the provided VOICE or EMAIL contact channels.
|
1824
|
+
# # Incident Manager sends the public-subject and public-content to the provided SMS contact channels. Sender is used to
|
1825
|
+
# # track who started the engagement.
|
1826
|
+
#
|
1827
|
+
# resp = client.start_engagement({
|
1828
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1829
|
+
# content: "Testing engagements",
|
1830
|
+
# public_content: "Testing engagements",
|
1831
|
+
# public_subject: "test",
|
1832
|
+
# sender: "tester",
|
1833
|
+
# subject: "test",
|
1834
|
+
# })
|
1835
|
+
#
|
1836
|
+
# resp.to_h outputs the following:
|
1837
|
+
# {
|
1838
|
+
# engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f",
|
1839
|
+
# }
|
1840
|
+
#
|
1841
|
+
# @example Example: Example 2: To page a contact in the provided escalation plan.
|
1842
|
+
#
|
1843
|
+
# # The following start-engagement engages contact's through an escalation plan. Each contact is paged according to their
|
1844
|
+
# # engagement plan.
|
1845
|
+
#
|
1846
|
+
# resp = client.start_engagement({
|
1847
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
|
1848
|
+
# content: "Testing engagements",
|
1849
|
+
# public_content: "Testing engagements",
|
1850
|
+
# public_subject: "test",
|
1851
|
+
# sender: "tester",
|
1852
|
+
# subject: "test",
|
1853
|
+
# })
|
1854
|
+
#
|
1855
|
+
# resp.to_h outputs the following:
|
1856
|
+
# {
|
1857
|
+
# engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356",
|
1858
|
+
# }
|
1859
|
+
#
|
1278
1860
|
# @example Request syntax with placeholder values
|
1279
1861
|
#
|
1280
1862
|
# resp = client.start_engagement({
|
@@ -1312,6 +1894,19 @@ module Aws::SSMContacts
|
|
1312
1894
|
#
|
1313
1895
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1314
1896
|
#
|
1897
|
+
#
|
1898
|
+
# @example Example: To stop an engagement
|
1899
|
+
#
|
1900
|
+
# # The following stop-engagement example stops an engagement from paging further contacts and contact channels.
|
1901
|
+
#
|
1902
|
+
# resp = client.stop_engagement({
|
1903
|
+
# engagement_id: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356",
|
1904
|
+
# })
|
1905
|
+
#
|
1906
|
+
# resp.to_h outputs the following:
|
1907
|
+
# {
|
1908
|
+
# }
|
1909
|
+
#
|
1315
1910
|
# @example Request syntax with placeholder values
|
1316
1911
|
#
|
1317
1912
|
# resp = client.stop_engagement({
|
@@ -1339,6 +1934,25 @@ module Aws::SSMContacts
|
|
1339
1934
|
#
|
1340
1935
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1341
1936
|
#
|
1937
|
+
#
|
1938
|
+
# @example Example: To tag a contact
|
1939
|
+
#
|
1940
|
+
# # The following tag-resource example tags a specified contact with the provided tag key value pair.
|
1941
|
+
#
|
1942
|
+
# resp = client.tag_resource({
|
1943
|
+
# resource_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
1944
|
+
# tags: [
|
1945
|
+
# {
|
1946
|
+
# key: "group1",
|
1947
|
+
# value: "1",
|
1948
|
+
# },
|
1949
|
+
# ],
|
1950
|
+
# })
|
1951
|
+
#
|
1952
|
+
# resp.to_h outputs the following:
|
1953
|
+
# {
|
1954
|
+
# }
|
1955
|
+
#
|
1342
1956
|
# @example Request syntax with placeholder values
|
1343
1957
|
#
|
1344
1958
|
# resp = client.tag_resource({
|
@@ -1370,6 +1984,22 @@ module Aws::SSMContacts
|
|
1370
1984
|
#
|
1371
1985
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1372
1986
|
#
|
1987
|
+
#
|
1988
|
+
# @example Example: To remove tags from a contact
|
1989
|
+
#
|
1990
|
+
# # The following untag-resource example removes the group1 tag from the specified contact.
|
1991
|
+
#
|
1992
|
+
# resp = client.untag_resource({
|
1993
|
+
# resource_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
1994
|
+
# tag_keys: [
|
1995
|
+
# "group1",
|
1996
|
+
# ],
|
1997
|
+
# })
|
1998
|
+
#
|
1999
|
+
# resp.to_h outputs the following:
|
2000
|
+
# {
|
2001
|
+
# }
|
2002
|
+
#
|
1373
2003
|
# @example Request syntax with placeholder values
|
1374
2004
|
#
|
1375
2005
|
# resp = client.untag_resource({
|
@@ -1402,6 +2032,57 @@ module Aws::SSMContacts
|
|
1402
2032
|
#
|
1403
2033
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1404
2034
|
#
|
2035
|
+
#
|
2036
|
+
# @example Example: To update the engagement plan of contact
|
2037
|
+
#
|
2038
|
+
# # The following update-contact example updates the engagement plan of the contact Akua to include the three types of
|
2039
|
+
# # contacts channels. This is done after creating contact channels for Akua.
|
2040
|
+
#
|
2041
|
+
# resp = client.update_contact({
|
2042
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
2043
|
+
# plan: {
|
2044
|
+
# stages: [
|
2045
|
+
# {
|
2046
|
+
# duration_in_minutes: 5,
|
2047
|
+
# targets: [
|
2048
|
+
# {
|
2049
|
+
# channel_target_info: {
|
2050
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65",
|
2051
|
+
# retry_interval_in_minutes: 1,
|
2052
|
+
# },
|
2053
|
+
# },
|
2054
|
+
# ],
|
2055
|
+
# },
|
2056
|
+
# {
|
2057
|
+
# duration_in_minutes: 5,
|
2058
|
+
# targets: [
|
2059
|
+
# {
|
2060
|
+
# channel_target_info: {
|
2061
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad",
|
2062
|
+
# retry_interval_in_minutes: 1,
|
2063
|
+
# },
|
2064
|
+
# },
|
2065
|
+
# ],
|
2066
|
+
# },
|
2067
|
+
# {
|
2068
|
+
# duration_in_minutes: 5,
|
2069
|
+
# targets: [
|
2070
|
+
# {
|
2071
|
+
# channel_target_info: {
|
2072
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a",
|
2073
|
+
# retry_interval_in_minutes: 1,
|
2074
|
+
# },
|
2075
|
+
# },
|
2076
|
+
# ],
|
2077
|
+
# },
|
2078
|
+
# ],
|
2079
|
+
# },
|
2080
|
+
# })
|
2081
|
+
#
|
2082
|
+
# resp.to_h outputs the following:
|
2083
|
+
# {
|
2084
|
+
# }
|
2085
|
+
#
|
1405
2086
|
# @example Request syntax with placeholder values
|
1406
2087
|
#
|
1407
2088
|
# resp = client.update_contact({
|
@@ -1444,7 +2125,7 @@ module Aws::SSMContacts
|
|
1444
2125
|
# update.
|
1445
2126
|
#
|
1446
2127
|
# @option params [String] :name
|
1447
|
-
# The name of the contact channel
|
2128
|
+
# The name of the contact channel.
|
1448
2129
|
#
|
1449
2130
|
# @option params [Types::ContactChannelAddress] :delivery_address
|
1450
2131
|
# The details that Incident Manager uses when trying to engage the
|
@@ -1452,6 +2133,23 @@ module Aws::SSMContacts
|
|
1452
2133
|
#
|
1453
2134
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1454
2135
|
#
|
2136
|
+
#
|
2137
|
+
# @example Example: To update a contact channel
|
2138
|
+
#
|
2139
|
+
# # The following update-contact-channel example updates the name and delivery address of a contact channel.
|
2140
|
+
#
|
2141
|
+
# resp = client.update_contact_channel({
|
2142
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad",
|
2143
|
+
# delivery_address: {
|
2144
|
+
# simple_address: "+15005550198",
|
2145
|
+
# },
|
2146
|
+
# name: "akuas voice channel",
|
2147
|
+
# })
|
2148
|
+
#
|
2149
|
+
# resp.to_h outputs the following:
|
2150
|
+
# {
|
2151
|
+
# }
|
2152
|
+
#
|
1455
2153
|
# @example Request syntax with placeholder values
|
1456
2154
|
#
|
1457
2155
|
# resp = client.update_contact_channel({
|
@@ -1484,7 +2182,7 @@ module Aws::SSMContacts
|
|
1484
2182
|
params: params,
|
1485
2183
|
config: config)
|
1486
2184
|
context[:gem_name] = 'aws-sdk-ssmcontacts'
|
1487
|
-
context[:gem_version] = '1.
|
2185
|
+
context[:gem_version] = '1.9.0'
|
1488
2186
|
Seahorse::Client::Request.new(handlers, context)
|
1489
2187
|
end
|
1490
2188
|
|
@@ -74,7 +74,7 @@ module Aws::SSMContacts
|
|
74
74
|
#
|
75
75
|
class AcceptPageResult < Aws::EmptyStructure; end
|
76
76
|
|
77
|
-
# You don't have sufficient access to perform this
|
77
|
+
# You don't have sufficient access to perform this operation.
|
78
78
|
#
|
79
79
|
# @!attribute [rw] message
|
80
80
|
# @return [String]
|
@@ -358,7 +358,7 @@ module Aws::SSMContacts
|
|
358
358
|
# @return [Boolean]
|
359
359
|
#
|
360
360
|
# @!attribute [rw] idempotency_token
|
361
|
-
# A token ensuring that the
|
361
|
+
# A token ensuring that the operation is called only once with the
|
362
362
|
# specified details.
|
363
363
|
#
|
364
364
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -379,7 +379,7 @@ module Aws::SSMContacts
|
|
379
379
|
end
|
380
380
|
|
381
381
|
# @!attribute [rw] contact_channel_arn
|
382
|
-
# The ARN of the contact channel.
|
382
|
+
# The Amazon Resource Name (ARN) of the contact channel.
|
383
383
|
# @return [String]
|
384
384
|
#
|
385
385
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/CreateContactChannelResult AWS API Documentation
|
@@ -451,7 +451,7 @@ module Aws::SSMContacts
|
|
451
451
|
# @return [Array<Types::Tag>]
|
452
452
|
#
|
453
453
|
# @!attribute [rw] idempotency_token
|
454
|
-
# A token ensuring that the
|
454
|
+
# A token ensuring that the operation is called only once with the
|
455
455
|
# specified details.
|
456
456
|
#
|
457
457
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -484,7 +484,7 @@ module Aws::SSMContacts
|
|
484
484
|
include Aws::Structure
|
485
485
|
end
|
486
486
|
|
487
|
-
# The
|
487
|
+
# The operation failed to due an encryption key error.
|
488
488
|
#
|
489
489
|
# @!attribute [rw] message
|
490
490
|
# @return [String]
|
@@ -1607,7 +1607,7 @@ module Aws::SSMContacts
|
|
1607
1607
|
# @return [String]
|
1608
1608
|
#
|
1609
1609
|
# @!attribute [rw] idempotency_token
|
1610
|
-
# A token ensuring that the
|
1610
|
+
# A token ensuring that the operation is called only once with the
|
1611
1611
|
# specified details.
|
1612
1612
|
#
|
1613
1613
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -1732,7 +1732,7 @@ module Aws::SSMContacts
|
|
1732
1732
|
#
|
1733
1733
|
class TagResourceResult < Aws::EmptyStructure; end
|
1734
1734
|
|
1735
|
-
# The contact or contact channel that
|
1735
|
+
# The contact or contact channel that's being engaged.
|
1736
1736
|
#
|
1737
1737
|
# @note When making an API call, you may pass Target
|
1738
1738
|
# data as a hash:
|
@@ -1866,7 +1866,7 @@ module Aws::SSMContacts
|
|
1866
1866
|
# @return [String]
|
1867
1867
|
#
|
1868
1868
|
# @!attribute [rw] name
|
1869
|
-
# The name of the contact channel
|
1869
|
+
# The name of the contact channel.
|
1870
1870
|
# @return [String]
|
1871
1871
|
#
|
1872
1872
|
# @!attribute [rw] delivery_address
|
@@ -1944,8 +1944,8 @@ module Aws::SSMContacts
|
|
1944
1944
|
#
|
1945
1945
|
class UpdateContactResult < Aws::EmptyStructure; end
|
1946
1946
|
|
1947
|
-
# The input fails to satisfy the constraints specified by an
|
1948
|
-
# service.
|
1947
|
+
# The input fails to satisfy the constraints specified by an Amazon Web
|
1948
|
+
# Services service.
|
1949
1949
|
#
|
1950
1950
|
# @!attribute [rw] message
|
1951
1951
|
# @return [String]
|
data/lib/aws-sdk-ssmcontacts.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-ssmcontacts
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.9.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-
|
11
|
+
date: 2021-11-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.122.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.122.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|
@@ -76,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
76
76
|
requirements:
|
77
77
|
- - ">="
|
78
78
|
- !ruby/object:Gem::Version
|
79
|
-
version: '
|
79
|
+
version: '2.3'
|
80
80
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
81
81
|
requirements:
|
82
82
|
- - ">="
|