aws-sdk-ssmcontacts 1.3.0 → 1.7.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ssmcontacts/client.rb +708 -6
- data/lib/aws-sdk-ssmcontacts/client_api.rb +2 -0
- data/lib/aws-sdk-ssmcontacts/types.rb +28 -12
- 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: b7851ff1d5f57fdc10b884d98fbda1b8711364def0747d5dcf3566a5d6f5d435
|
4
|
+
data.tar.gz: 6351b3eeb5696b538b415f0873db35695e9dcfbc48e82bc30ab51be548042984
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a4616239d2d939895d7919a4a97f81342c9370e53247f65debd74ac34ed512c6711710484b6ae1ac604772465fb785b4a05619d5e339e0a69aecffdc649ee22c
|
7
|
+
data.tar.gz: 1da3bb4aaba6ebc6eadd6c98fad98e41f2ad9e638a7d5b95bf5536ee4c20f03245e599d9713256039c19bf4b5e02bd0c7d9f326261ec1e86fc03791b6764d91f
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.7.0 (2021-09-07)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Added SDK examples for SSM-Contacts.
|
8
|
+
|
9
|
+
1.6.0 (2021-09-01)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.5.0 (2021-08-02)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Added new attribute in AcceptCode API. AcceptCodeValidation takes in two values - ENFORCE, IGNORE. ENFORCE forces validation of accept code and IGNORE ignores it which is also the default behavior; Corrected TagKeyList length from 200 to 50
|
18
|
+
|
19
|
+
1.4.0 (2021-07-30)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.3.0 (2021-07-28)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.7.0
|
@@ -355,8 +355,35 @@ module Aws::SSMContacts
|
|
355
355
|
# @option params [required, String] :accept_code
|
356
356
|
# The accept code is a 6-digit code used to acknowledge the page.
|
357
357
|
#
|
358
|
+
# @option params [String] :accept_code_validation
|
359
|
+
# An optional field that Incident Manager uses to `ENFORCE` `AcceptCode`
|
360
|
+
# validation when acknowledging an page. Acknowledgement can occur by
|
361
|
+
# replying to a page, or when entering the AcceptCode in the console.
|
362
|
+
# Enforcing AcceptCode validation causes Incident Manager to verify that
|
363
|
+
# the code entered by the user matches the code sent by Incident Manager
|
364
|
+
# with the page.
|
365
|
+
#
|
366
|
+
# Incident Manager can also `IGNORE` `AcceptCode` validation. Ignoring
|
367
|
+
# `AcceptCode` validation causes Incident Manager to accept any value
|
368
|
+
# entered for the `AcceptCode`.
|
369
|
+
#
|
358
370
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
359
371
|
#
|
372
|
+
#
|
373
|
+
# @example Example: To accept a page during and engagement
|
374
|
+
#
|
375
|
+
# # The following accept-page operation uses an accept code sent to the contact channel to accept a page.
|
376
|
+
#
|
377
|
+
# resp = client.accept_page({
|
378
|
+
# accept_code: "425440",
|
379
|
+
# accept_type: "READ",
|
380
|
+
# page_id: "arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3",
|
381
|
+
# })
|
382
|
+
#
|
383
|
+
# resp.to_h outputs the following:
|
384
|
+
# {
|
385
|
+
# }
|
386
|
+
#
|
360
387
|
# @example Request syntax with placeholder values
|
361
388
|
#
|
362
389
|
# resp = client.accept_page({
|
@@ -365,6 +392,7 @@ module Aws::SSMContacts
|
|
365
392
|
# accept_type: "DELIVERED", # required, accepts DELIVERED, READ
|
366
393
|
# note: "ReceiptInfo",
|
367
394
|
# accept_code: "AcceptCode", # required
|
395
|
+
# accept_code_validation: "IGNORE", # accepts IGNORE, ENFORCE
|
368
396
|
# })
|
369
397
|
#
|
370
398
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/AcceptPage AWS API Documentation
|
@@ -388,6 +416,20 @@ module Aws::SSMContacts
|
|
388
416
|
#
|
389
417
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
390
418
|
#
|
419
|
+
#
|
420
|
+
# @example Example: Activate a contact's contact channel
|
421
|
+
#
|
422
|
+
# # The following activate-contact-channel example activates a contact channel and makes it usable as part of an incident.
|
423
|
+
#
|
424
|
+
# resp = client.activate_contact_channel({
|
425
|
+
# activation_code: "466136",
|
426
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
427
|
+
# })
|
428
|
+
#
|
429
|
+
# resp.to_h outputs the following:
|
430
|
+
# {
|
431
|
+
# }
|
432
|
+
#
|
391
433
|
# @example Request syntax with placeholder values
|
392
434
|
#
|
393
435
|
# resp = client.activate_contact_channel({
|
@@ -429,7 +471,7 @@ module Aws::SSMContacts
|
|
429
471
|
# first Region of your replication set.
|
430
472
|
#
|
431
473
|
# @option params [String] :idempotency_token
|
432
|
-
# A token ensuring that the
|
474
|
+
# A token ensuring that the operation is called only once with the
|
433
475
|
# specified details.
|
434
476
|
#
|
435
477
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -439,6 +481,28 @@ module Aws::SSMContacts
|
|
439
481
|
#
|
440
482
|
# * {Types::CreateContactResult#contact_arn #contact_arn} => String
|
441
483
|
#
|
484
|
+
#
|
485
|
+
# @example Example: To create a contact
|
486
|
+
#
|
487
|
+
# # The following create-contact example creates a contact in your environment with a blank plan. The plan can be updated
|
488
|
+
# # after creating contact channels. Use the create-contact-channel operation with the output ARN of this command. After you
|
489
|
+
# # have created contact channels for this contact use update-contact to update the plan.
|
490
|
+
#
|
491
|
+
# resp = client.create_contact({
|
492
|
+
# alias: "akuam",
|
493
|
+
# display_name: "Akua Mansa",
|
494
|
+
# plan: {
|
495
|
+
# stages: [
|
496
|
+
# ],
|
497
|
+
# },
|
498
|
+
# type: "PERSONAL",
|
499
|
+
# })
|
500
|
+
#
|
501
|
+
# resp.to_h outputs the following:
|
502
|
+
# {
|
503
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
504
|
+
# }
|
505
|
+
#
|
442
506
|
# @example Request syntax with placeholder values
|
443
507
|
#
|
444
508
|
# resp = client.create_contact({
|
@@ -522,7 +586,7 @@ module Aws::SSMContacts
|
|
522
586
|
# until it has been activated.
|
523
587
|
#
|
524
588
|
# @option params [String] :idempotency_token
|
525
|
-
# A token ensuring that the
|
589
|
+
# A token ensuring that the operation is called only once with the
|
526
590
|
# specified details.
|
527
591
|
#
|
528
592
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -532,6 +596,26 @@ module Aws::SSMContacts
|
|
532
596
|
#
|
533
597
|
# * {Types::CreateContactChannelResult#contact_channel_arn #contact_channel_arn} => String
|
534
598
|
#
|
599
|
+
#
|
600
|
+
# @example Example: To create a contact channel
|
601
|
+
#
|
602
|
+
# # Creates a contact channel of type SMS for the contact Akua Mansa. Contact channels can be created of type SMS, EMAIL, or
|
603
|
+
# # VOICE.
|
604
|
+
#
|
605
|
+
# resp = client.create_contact_channel({
|
606
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
607
|
+
# delivery_address: {
|
608
|
+
# simple_address: "+15005550199",
|
609
|
+
# },
|
610
|
+
# name: "akuas sms-test",
|
611
|
+
# type: "SMS",
|
612
|
+
# })
|
613
|
+
#
|
614
|
+
# resp.to_h outputs the following:
|
615
|
+
# {
|
616
|
+
# contact_channel_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/02f506b9-ea5d-4764-af89-2daa793ff024",
|
617
|
+
# }
|
618
|
+
#
|
535
619
|
# @example Request syntax with placeholder values
|
536
620
|
#
|
537
621
|
# resp = client.create_contact_channel({
|
@@ -567,6 +651,21 @@ module Aws::SSMContacts
|
|
567
651
|
#
|
568
652
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
569
653
|
#
|
654
|
+
#
|
655
|
+
# @example Example: To deactivate a contact channel
|
656
|
+
#
|
657
|
+
# # The following ``deactivate-contact-channel`` example deactivates a contact channel. Deactivating a contact channel means
|
658
|
+
# # the contact channel will no longer be paged during an incident. You can also reactivate a contact channel at any time
|
659
|
+
# # using the activate-contact-channel operation.
|
660
|
+
#
|
661
|
+
# resp = client.deactivate_contact_channel({
|
662
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
663
|
+
# })
|
664
|
+
#
|
665
|
+
# resp.to_h outputs the following:
|
666
|
+
# {
|
667
|
+
# }
|
668
|
+
#
|
570
669
|
# @example Request syntax with placeholder values
|
571
670
|
#
|
572
671
|
# resp = client.deactivate_contact_channel({
|
@@ -593,6 +692,20 @@ module Aws::SSMContacts
|
|
593
692
|
#
|
594
693
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
595
694
|
#
|
695
|
+
#
|
696
|
+
# @example Example: To delete a contact
|
697
|
+
#
|
698
|
+
# # The following delete-contact example deletes a contact. The contact will no longer be reachable from any escalation plan
|
699
|
+
# # that refers to them.
|
700
|
+
#
|
701
|
+
# resp = client.delete_contact({
|
702
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr",
|
703
|
+
# })
|
704
|
+
#
|
705
|
+
# resp.to_h outputs the following:
|
706
|
+
# {
|
707
|
+
# }
|
708
|
+
#
|
596
709
|
# @example Request syntax with placeholder values
|
597
710
|
#
|
598
711
|
# resp = client.delete_contact({
|
@@ -619,6 +732,20 @@ module Aws::SSMContacts
|
|
619
732
|
#
|
620
733
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
621
734
|
#
|
735
|
+
#
|
736
|
+
# @example Example: To delete a contact channel
|
737
|
+
#
|
738
|
+
# # The following delete-contact-channel example deletes a contact channel. Deleting a contact channel ensures the contact
|
739
|
+
# # channel will not be paged during an incident.
|
740
|
+
#
|
741
|
+
# resp = client.delete_contact_channel({
|
742
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/13149bad-52ee-45ea-ae1e-45857f78f9b2",
|
743
|
+
# })
|
744
|
+
#
|
745
|
+
# resp.to_h outputs the following:
|
746
|
+
# {
|
747
|
+
# }
|
748
|
+
#
|
622
749
|
# @example Request syntax with placeholder values
|
623
750
|
#
|
624
751
|
# resp = client.delete_contact_channel({
|
@@ -655,6 +782,28 @@ module Aws::SSMContacts
|
|
655
782
|
# * {Types::DescribeEngagementResult#start_time #start_time} => Time
|
656
783
|
# * {Types::DescribeEngagementResult#stop_time #stop_time} => Time
|
657
784
|
#
|
785
|
+
#
|
786
|
+
# @example Example: To describe the details of an engagement
|
787
|
+
#
|
788
|
+
# # The following describe-engagement example lists the details of an engagement to a contact or escalation plan. The
|
789
|
+
# # subject and content are sent to the contact channels.
|
790
|
+
#
|
791
|
+
# resp = client.describe_engagement({
|
792
|
+
# engagement_id: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356",
|
793
|
+
# })
|
794
|
+
#
|
795
|
+
# resp.to_h outputs the following:
|
796
|
+
# {
|
797
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
|
798
|
+
# content: "Testing engagements",
|
799
|
+
# engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356",
|
800
|
+
# public_content: "Testing engagements",
|
801
|
+
# public_subject: "test",
|
802
|
+
# sender: "tester",
|
803
|
+
# start_time: Time.parse("$2021-05-18T18:25:41.151000+00:00"),
|
804
|
+
# subject: "test",
|
805
|
+
# }
|
806
|
+
#
|
658
807
|
# @example Request syntax with placeholder values
|
659
808
|
#
|
660
809
|
# resp = client.describe_engagement({
|
@@ -703,6 +852,31 @@ module Aws::SSMContacts
|
|
703
852
|
# * {Types::DescribePageResult#read_time #read_time} => Time
|
704
853
|
# * {Types::DescribePageResult#delivery_time #delivery_time} => Time
|
705
854
|
#
|
855
|
+
#
|
856
|
+
# @example Example: To list the details of a page to a contact channel
|
857
|
+
#
|
858
|
+
# # The following describe-page example lists details of a page to a contact channel. The page will include the subject and
|
859
|
+
# # content provided.
|
860
|
+
#
|
861
|
+
# resp = client.describe_page({
|
862
|
+
# page_id: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93",
|
863
|
+
# })
|
864
|
+
#
|
865
|
+
# resp.to_h outputs the following:
|
866
|
+
# {
|
867
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
868
|
+
# content: "Testing engagements",
|
869
|
+
# delivery_time: Time.parse("2021-05-18T18:43:55.265000+00:00"),
|
870
|
+
# engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
|
871
|
+
# page_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93",
|
872
|
+
# public_content: "Testing engagements",
|
873
|
+
# public_subject: "test",
|
874
|
+
# read_time: Time.parse("2021-05-18T18:43:55.708000+00:00"),
|
875
|
+
# sender: "tester",
|
876
|
+
# sent_time: Time.parse("2021-05-18T18:43:29.301000+00:00"),
|
877
|
+
# subject: "test",
|
878
|
+
# }
|
879
|
+
#
|
706
880
|
# @example Request syntax with placeholder values
|
707
881
|
#
|
708
882
|
# resp = client.describe_page({
|
@@ -746,6 +920,113 @@ module Aws::SSMContacts
|
|
746
920
|
# * {Types::GetContactResult#type #type} => String
|
747
921
|
# * {Types::GetContactResult#plan #plan} => Types::Plan
|
748
922
|
#
|
923
|
+
#
|
924
|
+
# @example Example: Example 1: To describe a contact plan
|
925
|
+
#
|
926
|
+
# # The following get-contact example describes a contact.
|
927
|
+
#
|
928
|
+
# resp = client.get_contact({
|
929
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
930
|
+
# })
|
931
|
+
#
|
932
|
+
# resp.to_h outputs the following:
|
933
|
+
# {
|
934
|
+
# alias: "akuam",
|
935
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
936
|
+
# display_name: "Akua Mansa",
|
937
|
+
# plan: {
|
938
|
+
# stages: [
|
939
|
+
# {
|
940
|
+
# duration_in_minutes: 5,
|
941
|
+
# targets: [
|
942
|
+
# {
|
943
|
+
# channel_target_info: {
|
944
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65",
|
945
|
+
# retry_interval_in_minutes: 1,
|
946
|
+
# },
|
947
|
+
# },
|
948
|
+
# ],
|
949
|
+
# },
|
950
|
+
# {
|
951
|
+
# duration_in_minutes: 5,
|
952
|
+
# targets: [
|
953
|
+
# {
|
954
|
+
# channel_target_info: {
|
955
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad",
|
956
|
+
# retry_interval_in_minutes: 1,
|
957
|
+
# },
|
958
|
+
# },
|
959
|
+
# ],
|
960
|
+
# },
|
961
|
+
# {
|
962
|
+
# duration_in_minutes: 5,
|
963
|
+
# targets: [
|
964
|
+
# {
|
965
|
+
# channel_target_info: {
|
966
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a",
|
967
|
+
# retry_interval_in_minutes: 1,
|
968
|
+
# },
|
969
|
+
# },
|
970
|
+
# ],
|
971
|
+
# },
|
972
|
+
# ],
|
973
|
+
# },
|
974
|
+
# type: "PERSONAL",
|
975
|
+
# }
|
976
|
+
#
|
977
|
+
# @example Example: Example 2: To describe an escalation plan
|
978
|
+
#
|
979
|
+
# # The following get-contact example describes an escalation plan.
|
980
|
+
#
|
981
|
+
# resp = client.get_contact({
|
982
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
|
983
|
+
# })
|
984
|
+
#
|
985
|
+
# resp.to_h outputs the following:
|
986
|
+
# {
|
987
|
+
# alias: "example_escalation",
|
988
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
|
989
|
+
# display_name: "Example Escalation Plan",
|
990
|
+
# plan: {
|
991
|
+
# stages: [
|
992
|
+
# {
|
993
|
+
# duration_in_minutes: 5,
|
994
|
+
# targets: [
|
995
|
+
# {
|
996
|
+
# contact_target_info: {
|
997
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
998
|
+
# is_essential: true,
|
999
|
+
# },
|
1000
|
+
# },
|
1001
|
+
# ],
|
1002
|
+
# },
|
1003
|
+
# {
|
1004
|
+
# duration_in_minutes: 5,
|
1005
|
+
# targets: [
|
1006
|
+
# {
|
1007
|
+
# contact_target_info: {
|
1008
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr",
|
1009
|
+
# is_essential: false,
|
1010
|
+
# },
|
1011
|
+
# },
|
1012
|
+
# ],
|
1013
|
+
# },
|
1014
|
+
# {
|
1015
|
+
# duration_in_minutes: 0,
|
1016
|
+
# targets: [
|
1017
|
+
# {
|
1018
|
+
# contact_target_info: {
|
1019
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi",
|
1020
|
+
# is_essential: false,
|
1021
|
+
# },
|
1022
|
+
# },
|
1023
|
+
# ],
|
1024
|
+
# },
|
1025
|
+
# ],
|
1026
|
+
# },
|
1027
|
+
# type: "ESCALATION",
|
1028
|
+
# }
|
1029
|
+
#
|
749
1030
|
# @example Request syntax with placeholder values
|
750
1031
|
#
|
751
1032
|
# resp = client.get_contact({
|
@@ -790,6 +1071,27 @@ module Aws::SSMContacts
|
|
790
1071
|
# * {Types::GetContactChannelResult#delivery_address #delivery_address} => Types::ContactChannelAddress
|
791
1072
|
# * {Types::GetContactChannelResult#activation_status #activation_status} => String
|
792
1073
|
#
|
1074
|
+
#
|
1075
|
+
# @example Example: To list the details of a contact channel
|
1076
|
+
#
|
1077
|
+
# # The following get-contact-channel example lists the details of a contact channel.
|
1078
|
+
#
|
1079
|
+
# resp = client.get_contact_channel({
|
1080
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
1081
|
+
# })
|
1082
|
+
#
|
1083
|
+
# resp.to_h outputs the following:
|
1084
|
+
# {
|
1085
|
+
# activation_status: "ACTIVATED",
|
1086
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1087
|
+
# contact_channel_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
1088
|
+
# delivery_address: {
|
1089
|
+
# simple_address: "+15005550199",
|
1090
|
+
# },
|
1091
|
+
# name: "akuas sms",
|
1092
|
+
# type: "SMS",
|
1093
|
+
# }
|
1094
|
+
#
|
793
1095
|
# @example Request syntax with placeholder values
|
794
1096
|
#
|
795
1097
|
# resp = client.get_contact_channel({
|
@@ -825,6 +1127,21 @@ module Aws::SSMContacts
|
|
825
1127
|
# * {Types::GetContactPolicyResult#contact_arn #contact_arn} => String
|
826
1128
|
# * {Types::GetContactPolicyResult#policy #policy} => String
|
827
1129
|
#
|
1130
|
+
#
|
1131
|
+
# @example Example: To list the resource policies of a contact
|
1132
|
+
#
|
1133
|
+
# # The following get-contact-policy example lists the resource policies associated with the specified contact.
|
1134
|
+
#
|
1135
|
+
# resp = client.get_contact_policy({
|
1136
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
1137
|
+
# })
|
1138
|
+
#
|
1139
|
+
# resp.to_h outputs the following:
|
1140
|
+
# {
|
1141
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
1142
|
+
# 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/*\"]}]}",
|
1143
|
+
# }
|
1144
|
+
#
|
828
1145
|
# @example Request syntax with placeholder values
|
829
1146
|
#
|
830
1147
|
# resp = client.get_contact_policy({
|
@@ -863,6 +1180,31 @@ module Aws::SSMContacts
|
|
863
1180
|
#
|
864
1181
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
865
1182
|
#
|
1183
|
+
#
|
1184
|
+
# @example Example: To list the contact channels of a contact
|
1185
|
+
#
|
1186
|
+
# # The following list-contact-channels example lists the available contact channels of the specified contact.
|
1187
|
+
#
|
1188
|
+
# resp = client.list_contact_channels({
|
1189
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1190
|
+
# })
|
1191
|
+
#
|
1192
|
+
# resp.to_h outputs the following:
|
1193
|
+
# {
|
1194
|
+
# contact_channels: [
|
1195
|
+
# {
|
1196
|
+
# activation_status: "ACTIVATED",
|
1197
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1198
|
+
# contact_channel_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
1199
|
+
# delivery_address: {
|
1200
|
+
# simple_address: "+15005550100",
|
1201
|
+
# },
|
1202
|
+
# name: "akuas sms",
|
1203
|
+
# type: "SMS",
|
1204
|
+
# },
|
1205
|
+
# ],
|
1206
|
+
# }
|
1207
|
+
#
|
866
1208
|
# @example Request syntax with placeholder values
|
867
1209
|
#
|
868
1210
|
# resp = client.list_contact_channels({
|
@@ -915,6 +1257,44 @@ module Aws::SSMContacts
|
|
915
1257
|
#
|
916
1258
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
917
1259
|
#
|
1260
|
+
#
|
1261
|
+
# @example Example: To list all escalation plans and contacts
|
1262
|
+
#
|
1263
|
+
# # The following list-contacts example lists the contacts and escalation plans in your account.
|
1264
|
+
#
|
1265
|
+
# resp = client.list_contacts({
|
1266
|
+
# })
|
1267
|
+
#
|
1268
|
+
# resp.to_h outputs the following:
|
1269
|
+
# {
|
1270
|
+
# contacts: [
|
1271
|
+
# {
|
1272
|
+
# alias: "akuam",
|
1273
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1274
|
+
# display_name: "Akua Mansa",
|
1275
|
+
# type: "PERSONAL",
|
1276
|
+
# },
|
1277
|
+
# {
|
1278
|
+
# alias: "alejr",
|
1279
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr",
|
1280
|
+
# display_name: "Alejandro Rosalez",
|
1281
|
+
# type: "PERSONAL",
|
1282
|
+
# },
|
1283
|
+
# {
|
1284
|
+
# alias: "anasi",
|
1285
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi",
|
1286
|
+
# display_name: "Ana Carolina Silva",
|
1287
|
+
# type: "PERSONAL",
|
1288
|
+
# },
|
1289
|
+
# {
|
1290
|
+
# alias: "example_escalation",
|
1291
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
|
1292
|
+
# display_name: "Example Escalation",
|
1293
|
+
# type: "ESCALATION",
|
1294
|
+
# },
|
1295
|
+
# ],
|
1296
|
+
# }
|
1297
|
+
#
|
918
1298
|
# @example Request syntax with placeholder values
|
919
1299
|
#
|
920
1300
|
# resp = client.list_contacts({
|
@@ -964,6 +1344,45 @@ module Aws::SSMContacts
|
|
964
1344
|
#
|
965
1345
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
966
1346
|
#
|
1347
|
+
#
|
1348
|
+
# @example Example: To list all engagements
|
1349
|
+
#
|
1350
|
+
# # The following list-engagements example lists engagements to escalation plans and contacts. You can also list engagements
|
1351
|
+
# # for a single incident.
|
1352
|
+
#
|
1353
|
+
# resp = client.list_engagements({
|
1354
|
+
# })
|
1355
|
+
#
|
1356
|
+
# resp.to_h outputs the following:
|
1357
|
+
# {
|
1358
|
+
# engagements: [
|
1359
|
+
# {
|
1360
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1361
|
+
# engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/91792571-0b53-4821-9f73-d25d13d9e529",
|
1362
|
+
# sender: "cli",
|
1363
|
+
# start_time: Time.parse("2021-05-18T20:37:50.300000+00:00"),
|
1364
|
+
# },
|
1365
|
+
# {
|
1366
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1367
|
+
# engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
|
1368
|
+
# sender: "cli",
|
1369
|
+
# start_time: Time.parse("2021-05-18T18:40:26.666000+00:00"),
|
1370
|
+
# },
|
1371
|
+
# {
|
1372
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
|
1373
|
+
# engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356",
|
1374
|
+
# sender: "cli",
|
1375
|
+
# start_time: Time.parse("2021-05-18T18:25:41.151000+00:00"),
|
1376
|
+
# },
|
1377
|
+
# {
|
1378
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1379
|
+
# engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f",
|
1380
|
+
# sender: "cli",
|
1381
|
+
# start_time: Time.parse("2021-05-18T18:20:58.093000+00:00"),
|
1382
|
+
# },
|
1383
|
+
# ],
|
1384
|
+
# }
|
1385
|
+
#
|
967
1386
|
# @example Request syntax with placeholder values
|
968
1387
|
#
|
969
1388
|
# resp = client.list_engagements({
|
@@ -1016,6 +1435,39 @@ module Aws::SSMContacts
|
|
1016
1435
|
#
|
1017
1436
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1018
1437
|
#
|
1438
|
+
#
|
1439
|
+
# @example Example: To list page receipts
|
1440
|
+
#
|
1441
|
+
# # The following command-name example lists whether a page was received or not by a contact.
|
1442
|
+
#
|
1443
|
+
# resp = client.list_page_receipts({
|
1444
|
+
# page_id: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3",
|
1445
|
+
# })
|
1446
|
+
#
|
1447
|
+
# resp.to_h outputs the following:
|
1448
|
+
# {
|
1449
|
+
# receipts: [
|
1450
|
+
# {
|
1451
|
+
# contact_channel_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
1452
|
+
# receipt_info: "425440",
|
1453
|
+
# receipt_time: Time.parse("2021-05-18T20:42:57.485000+00:00"),
|
1454
|
+
# receipt_type: "DELIVERED",
|
1455
|
+
# },
|
1456
|
+
# {
|
1457
|
+
# contact_channel_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
1458
|
+
# receipt_info: "425440",
|
1459
|
+
# receipt_time: Time.parse("2021-05-18T20:42:57.907000+00:00"),
|
1460
|
+
# receipt_type: "READ",
|
1461
|
+
# },
|
1462
|
+
# {
|
1463
|
+
# contact_channel_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
1464
|
+
# receipt_info: "SM6656c19132f1465f9c9c1123a5dde7c9",
|
1465
|
+
# receipt_time: Time.parse("2021-05-18T20:40:52.962000+00:00"),
|
1466
|
+
# receipt_type: "SENT",
|
1467
|
+
# },
|
1468
|
+
# ],
|
1469
|
+
# }
|
1470
|
+
#
|
1019
1471
|
# @example Request syntax with placeholder values
|
1020
1472
|
#
|
1021
1473
|
# resp = client.list_page_receipts({
|
@@ -1062,6 +1514,30 @@ module Aws::SSMContacts
|
|
1062
1514
|
#
|
1063
1515
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1064
1516
|
#
|
1517
|
+
#
|
1518
|
+
# @example Example: To list pages by contact
|
1519
|
+
#
|
1520
|
+
# # The following list-pages-by-contact example lists all pages to the specified contact.
|
1521
|
+
#
|
1522
|
+
# resp = client.list_pages_by_contact({
|
1523
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1524
|
+
# })
|
1525
|
+
#
|
1526
|
+
# resp.to_h outputs the following:
|
1527
|
+
# {
|
1528
|
+
# pages: [
|
1529
|
+
# {
|
1530
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1531
|
+
# delivery_time: Time.parse("2021-05-18T18:43:55.265000+00:00"),
|
1532
|
+
# engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
|
1533
|
+
# page_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93",
|
1534
|
+
# read_time: Time.parse("2021-05-18T18:43:55.708000+00:00"),
|
1535
|
+
# sender: "cli",
|
1536
|
+
# sent_time: Time.parse("2021-05-18T18:43:29.301000+00:00"),
|
1537
|
+
# },
|
1538
|
+
# ],
|
1539
|
+
# }
|
1540
|
+
#
|
1065
1541
|
# @example Request syntax with placeholder values
|
1066
1542
|
#
|
1067
1543
|
# resp = client.list_pages_by_contact({
|
@@ -1112,6 +1588,28 @@ module Aws::SSMContacts
|
|
1112
1588
|
#
|
1113
1589
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1114
1590
|
#
|
1591
|
+
#
|
1592
|
+
# @example Example: To list pages to contact channels started from an engagement.
|
1593
|
+
#
|
1594
|
+
# # The following list-pages-by-engagement example lists the pages that occurred while engaging the defined engagement plan.
|
1595
|
+
#
|
1596
|
+
# resp = client.list_pages_by_engagement({
|
1597
|
+
# engagement_id: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
|
1598
|
+
# })
|
1599
|
+
#
|
1600
|
+
# resp.to_h outputs the following:
|
1601
|
+
# {
|
1602
|
+
# pages: [
|
1603
|
+
# {
|
1604
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1605
|
+
# engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
|
1606
|
+
# page_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93",
|
1607
|
+
# sender: "cli",
|
1608
|
+
# sent_time: Time.parse("2021-05-18T18:40:27.245000+00:00"),
|
1609
|
+
# },
|
1610
|
+
# ],
|
1611
|
+
# }
|
1612
|
+
#
|
1115
1613
|
# @example Request syntax with placeholder values
|
1116
1614
|
#
|
1117
1615
|
# resp = client.list_pages_by_engagement({
|
@@ -1151,6 +1649,25 @@ module Aws::SSMContacts
|
|
1151
1649
|
#
|
1152
1650
|
# * {Types::ListTagsForResourceResult#tags #tags} => Array<Types::Tag>
|
1153
1651
|
#
|
1652
|
+
#
|
1653
|
+
# @example Example: To list tags for a contact
|
1654
|
+
#
|
1655
|
+
# # The following list-tags-for-resource example lists the tags of the specified contact.
|
1656
|
+
#
|
1657
|
+
# resp = client.list_tags_for_resource({
|
1658
|
+
# resource_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
1659
|
+
# })
|
1660
|
+
#
|
1661
|
+
# resp.to_h outputs the following:
|
1662
|
+
# {
|
1663
|
+
# tags: [
|
1664
|
+
# {
|
1665
|
+
# key: "group1",
|
1666
|
+
# value: "1",
|
1667
|
+
# },
|
1668
|
+
# ],
|
1669
|
+
# }
|
1670
|
+
#
|
1154
1671
|
# @example Request syntax with placeholder values
|
1155
1672
|
#
|
1156
1673
|
# resp = client.list_tags_for_resource({
|
@@ -1182,6 +1699,21 @@ module Aws::SSMContacts
|
|
1182
1699
|
#
|
1183
1700
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1184
1701
|
#
|
1702
|
+
#
|
1703
|
+
# @example Example: To share a contact and engagements
|
1704
|
+
#
|
1705
|
+
# # The following put-contact-policy example adds a resource policy to the contact Akua that shares the contact and related
|
1706
|
+
# # engagements with the principal.
|
1707
|
+
#
|
1708
|
+
# resp = client.put_contact_policy({
|
1709
|
+
# contact_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
1710
|
+
# 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/*\"]}]}",
|
1711
|
+
# })
|
1712
|
+
#
|
1713
|
+
# resp.to_h outputs the following:
|
1714
|
+
# {
|
1715
|
+
# }
|
1716
|
+
#
|
1185
1717
|
# @example Request syntax with placeholder values
|
1186
1718
|
#
|
1187
1719
|
# resp = client.put_contact_policy({
|
@@ -1200,7 +1732,7 @@ module Aws::SSMContacts
|
|
1200
1732
|
|
1201
1733
|
# Sends an activation code to a contact channel. The contact can use
|
1202
1734
|
# this code to activate the contact channel in the console or with the
|
1203
|
-
# `ActivateChannel`
|
1735
|
+
# `ActivateChannel` operation. Incident Manager can't engage a contact
|
1204
1736
|
# channel until it has been activated.
|
1205
1737
|
#
|
1206
1738
|
# @option params [required, String] :contact_channel_id
|
@@ -1208,6 +1740,19 @@ module Aws::SSMContacts
|
|
1208
1740
|
#
|
1209
1741
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1210
1742
|
#
|
1743
|
+
#
|
1744
|
+
# @example Example: To send an activation code
|
1745
|
+
#
|
1746
|
+
# # The following send-activation-code example sends an activation code and message to the specified contact channel.
|
1747
|
+
#
|
1748
|
+
# resp = client.send_activation_code({
|
1749
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/8ddae2d1-12c8-4e45-b852-c8587266c400",
|
1750
|
+
# })
|
1751
|
+
#
|
1752
|
+
# resp.to_h outputs the following:
|
1753
|
+
# {
|
1754
|
+
# }
|
1755
|
+
#
|
1211
1756
|
# @example Request syntax with placeholder values
|
1212
1757
|
#
|
1213
1758
|
# resp = client.send_activation_code({
|
@@ -1252,7 +1797,7 @@ module Aws::SSMContacts
|
|
1252
1797
|
# The ARN of the incident that the engagement is part of.
|
1253
1798
|
#
|
1254
1799
|
# @option params [String] :idempotency_token
|
1255
|
-
# A token ensuring that the
|
1800
|
+
# A token ensuring that the operation is called only once with the
|
1256
1801
|
# specified details.
|
1257
1802
|
#
|
1258
1803
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -1262,6 +1807,47 @@ module Aws::SSMContacts
|
|
1262
1807
|
#
|
1263
1808
|
# * {Types::StartEngagementResult#engagement_arn #engagement_arn} => String
|
1264
1809
|
#
|
1810
|
+
#
|
1811
|
+
# @example Example: Example 1: To page a contact's contact channels
|
1812
|
+
#
|
1813
|
+
# # The following start-engagement pages contact's contact channels. Sender, subject, public-subject, and public-content are
|
1814
|
+
# # all free from fields. Incident Manager sends the subject and content to the provided VOICE or EMAIL contact channels.
|
1815
|
+
# # Incident Manager sends the public-subject and public-content to the provided SMS contact channels. Sender is used to
|
1816
|
+
# # track who started the engagement.
|
1817
|
+
#
|
1818
|
+
# resp = client.start_engagement({
|
1819
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
1820
|
+
# content: "Testing engagements",
|
1821
|
+
# public_content: "Testing engagements",
|
1822
|
+
# public_subject: "test",
|
1823
|
+
# sender: "tester",
|
1824
|
+
# subject: "test",
|
1825
|
+
# })
|
1826
|
+
#
|
1827
|
+
# resp.to_h outputs the following:
|
1828
|
+
# {
|
1829
|
+
# engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f",
|
1830
|
+
# }
|
1831
|
+
#
|
1832
|
+
# @example Example: Example 2: To page a contact in the provided escalation plan.
|
1833
|
+
#
|
1834
|
+
# # The following start-engagement engages contact's through an escalation plan. Each contact is paged according to their
|
1835
|
+
# # engagement plan.
|
1836
|
+
#
|
1837
|
+
# resp = client.start_engagement({
|
1838
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
|
1839
|
+
# content: "Testing engagements",
|
1840
|
+
# public_content: "Testing engagements",
|
1841
|
+
# public_subject: "test",
|
1842
|
+
# sender: "tester",
|
1843
|
+
# subject: "test",
|
1844
|
+
# })
|
1845
|
+
#
|
1846
|
+
# resp.to_h outputs the following:
|
1847
|
+
# {
|
1848
|
+
# engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356",
|
1849
|
+
# }
|
1850
|
+
#
|
1265
1851
|
# @example Request syntax with placeholder values
|
1266
1852
|
#
|
1267
1853
|
# resp = client.start_engagement({
|
@@ -1299,6 +1885,19 @@ module Aws::SSMContacts
|
|
1299
1885
|
#
|
1300
1886
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1301
1887
|
#
|
1888
|
+
#
|
1889
|
+
# @example Example: To stop an engagement
|
1890
|
+
#
|
1891
|
+
# # The following stop-engagement example stops an engagement from paging further contacts and contact channels.
|
1892
|
+
#
|
1893
|
+
# resp = client.stop_engagement({
|
1894
|
+
# engagement_id: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356",
|
1895
|
+
# })
|
1896
|
+
#
|
1897
|
+
# resp.to_h outputs the following:
|
1898
|
+
# {
|
1899
|
+
# }
|
1900
|
+
#
|
1302
1901
|
# @example Request syntax with placeholder values
|
1303
1902
|
#
|
1304
1903
|
# resp = client.stop_engagement({
|
@@ -1326,6 +1925,25 @@ module Aws::SSMContacts
|
|
1326
1925
|
#
|
1327
1926
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1328
1927
|
#
|
1928
|
+
#
|
1929
|
+
# @example Example: To tag a contact
|
1930
|
+
#
|
1931
|
+
# # The following tag-resource example tags a specified contact with the provided tag key value pair.
|
1932
|
+
#
|
1933
|
+
# resp = client.tag_resource({
|
1934
|
+
# resource_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
1935
|
+
# tags: [
|
1936
|
+
# {
|
1937
|
+
# key: "group1",
|
1938
|
+
# value: "1",
|
1939
|
+
# },
|
1940
|
+
# ],
|
1941
|
+
# })
|
1942
|
+
#
|
1943
|
+
# resp.to_h outputs the following:
|
1944
|
+
# {
|
1945
|
+
# }
|
1946
|
+
#
|
1329
1947
|
# @example Request syntax with placeholder values
|
1330
1948
|
#
|
1331
1949
|
# resp = client.tag_resource({
|
@@ -1357,6 +1975,22 @@ module Aws::SSMContacts
|
|
1357
1975
|
#
|
1358
1976
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1359
1977
|
#
|
1978
|
+
#
|
1979
|
+
# @example Example: To remove tags from a contact
|
1980
|
+
#
|
1981
|
+
# # The following untag-resource example removes the group1 tag from the specified contact.
|
1982
|
+
#
|
1983
|
+
# resp = client.untag_resource({
|
1984
|
+
# resource_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
1985
|
+
# tag_keys: [
|
1986
|
+
# "group1",
|
1987
|
+
# ],
|
1988
|
+
# })
|
1989
|
+
#
|
1990
|
+
# resp.to_h outputs the following:
|
1991
|
+
# {
|
1992
|
+
# }
|
1993
|
+
#
|
1360
1994
|
# @example Request syntax with placeholder values
|
1361
1995
|
#
|
1362
1996
|
# resp = client.untag_resource({
|
@@ -1389,6 +2023,57 @@ module Aws::SSMContacts
|
|
1389
2023
|
#
|
1390
2024
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1391
2025
|
#
|
2026
|
+
#
|
2027
|
+
# @example Example: To update the engagement plan of contact
|
2028
|
+
#
|
2029
|
+
# # The following update-contact example updates the engagement plan of the contact Akua to include the three types of
|
2030
|
+
# # contacts channels. This is done after creating contact channels for Akua.
|
2031
|
+
#
|
2032
|
+
# resp = client.update_contact({
|
2033
|
+
# contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
2034
|
+
# plan: {
|
2035
|
+
# stages: [
|
2036
|
+
# {
|
2037
|
+
# duration_in_minutes: 5,
|
2038
|
+
# targets: [
|
2039
|
+
# {
|
2040
|
+
# channel_target_info: {
|
2041
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65",
|
2042
|
+
# retry_interval_in_minutes: 1,
|
2043
|
+
# },
|
2044
|
+
# },
|
2045
|
+
# ],
|
2046
|
+
# },
|
2047
|
+
# {
|
2048
|
+
# duration_in_minutes: 5,
|
2049
|
+
# targets: [
|
2050
|
+
# {
|
2051
|
+
# channel_target_info: {
|
2052
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad",
|
2053
|
+
# retry_interval_in_minutes: 1,
|
2054
|
+
# },
|
2055
|
+
# },
|
2056
|
+
# ],
|
2057
|
+
# },
|
2058
|
+
# {
|
2059
|
+
# duration_in_minutes: 5,
|
2060
|
+
# targets: [
|
2061
|
+
# {
|
2062
|
+
# channel_target_info: {
|
2063
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a",
|
2064
|
+
# retry_interval_in_minutes: 1,
|
2065
|
+
# },
|
2066
|
+
# },
|
2067
|
+
# ],
|
2068
|
+
# },
|
2069
|
+
# ],
|
2070
|
+
# },
|
2071
|
+
# })
|
2072
|
+
#
|
2073
|
+
# resp.to_h outputs the following:
|
2074
|
+
# {
|
2075
|
+
# }
|
2076
|
+
#
|
1392
2077
|
# @example Request syntax with placeholder values
|
1393
2078
|
#
|
1394
2079
|
# resp = client.update_contact({
|
@@ -1431,7 +2116,7 @@ module Aws::SSMContacts
|
|
1431
2116
|
# update.
|
1432
2117
|
#
|
1433
2118
|
# @option params [String] :name
|
1434
|
-
# The name of the contact channel
|
2119
|
+
# The name of the contact channel.
|
1435
2120
|
#
|
1436
2121
|
# @option params [Types::ContactChannelAddress] :delivery_address
|
1437
2122
|
# The details that Incident Manager uses when trying to engage the
|
@@ -1439,6 +2124,23 @@ module Aws::SSMContacts
|
|
1439
2124
|
#
|
1440
2125
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1441
2126
|
#
|
2127
|
+
#
|
2128
|
+
# @example Example: To update a contact channel
|
2129
|
+
#
|
2130
|
+
# # The following update-contact-channel example updates the name and delivery address of a contact channel.
|
2131
|
+
#
|
2132
|
+
# resp = client.update_contact_channel({
|
2133
|
+
# contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad",
|
2134
|
+
# delivery_address: {
|
2135
|
+
# simple_address: "+15005550198",
|
2136
|
+
# },
|
2137
|
+
# name: "akuas voice channel",
|
2138
|
+
# })
|
2139
|
+
#
|
2140
|
+
# resp.to_h outputs the following:
|
2141
|
+
# {
|
2142
|
+
# }
|
2143
|
+
#
|
1442
2144
|
# @example Request syntax with placeholder values
|
1443
2145
|
#
|
1444
2146
|
# resp = client.update_contact_channel({
|
@@ -1471,7 +2173,7 @@ module Aws::SSMContacts
|
|
1471
2173
|
params: params,
|
1472
2174
|
config: config)
|
1473
2175
|
context[:gem_name] = 'aws-sdk-ssmcontacts'
|
1474
|
-
context[:gem_version] = '1.
|
2176
|
+
context[:gem_version] = '1.7.0'
|
1475
2177
|
Seahorse::Client::Request.new(handlers, context)
|
1476
2178
|
end
|
1477
2179
|
|
@@ -14,6 +14,7 @@ module Aws::SSMContacts
|
|
14
14
|
include Seahorse::Model
|
15
15
|
|
16
16
|
AcceptCode = Shapes::StringShape.new(name: 'AcceptCode')
|
17
|
+
AcceptCodeValidation = Shapes::StringShape.new(name: 'AcceptCodeValidation')
|
17
18
|
AcceptPageRequest = Shapes::StructureShape.new(name: 'AcceptPageRequest')
|
18
19
|
AcceptPageResult = Shapes::StructureShape.new(name: 'AcceptPageResult')
|
19
20
|
AcceptType = Shapes::StringShape.new(name: 'AcceptType')
|
@@ -140,6 +141,7 @@ module Aws::SSMContacts
|
|
140
141
|
AcceptPageRequest.add_member(:accept_type, Shapes::ShapeRef.new(shape: AcceptType, required: true, location_name: "AcceptType"))
|
141
142
|
AcceptPageRequest.add_member(:note, Shapes::ShapeRef.new(shape: ReceiptInfo, location_name: "Note"))
|
142
143
|
AcceptPageRequest.add_member(:accept_code, Shapes::ShapeRef.new(shape: AcceptCode, required: true, location_name: "AcceptCode"))
|
144
|
+
AcceptPageRequest.add_member(:accept_code_validation, Shapes::ShapeRef.new(shape: AcceptCodeValidation, location_name: "AcceptCodeValidation"))
|
143
145
|
AcceptPageRequest.struct_class = Types::AcceptPageRequest
|
144
146
|
|
145
147
|
AcceptPageResult.struct_class = Types::AcceptPageResult
|
@@ -19,6 +19,7 @@ module Aws::SSMContacts
|
|
19
19
|
# accept_type: "DELIVERED", # required, accepts DELIVERED, READ
|
20
20
|
# note: "ReceiptInfo",
|
21
21
|
# accept_code: "AcceptCode", # required
|
22
|
+
# accept_code_validation: "IGNORE", # accepts IGNORE, ENFORCE
|
22
23
|
# }
|
23
24
|
#
|
24
25
|
# @!attribute [rw] page_id
|
@@ -43,6 +44,19 @@ module Aws::SSMContacts
|
|
43
44
|
# The accept code is a 6-digit code used to acknowledge the page.
|
44
45
|
# @return [String]
|
45
46
|
#
|
47
|
+
# @!attribute [rw] accept_code_validation
|
48
|
+
# An optional field that Incident Manager uses to `ENFORCE`
|
49
|
+
# `AcceptCode` validation when acknowledging an page. Acknowledgement
|
50
|
+
# can occur by replying to a page, or when entering the AcceptCode in
|
51
|
+
# the console. Enforcing AcceptCode validation causes Incident Manager
|
52
|
+
# to verify that the code entered by the user matches the code sent by
|
53
|
+
# Incident Manager with the page.
|
54
|
+
#
|
55
|
+
# Incident Manager can also `IGNORE` `AcceptCode` validation. Ignoring
|
56
|
+
# `AcceptCode` validation causes Incident Manager to accept any value
|
57
|
+
# entered for the `AcceptCode`.
|
58
|
+
# @return [String]
|
59
|
+
#
|
46
60
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/AcceptPageRequest AWS API Documentation
|
47
61
|
#
|
48
62
|
class AcceptPageRequest < Struct.new(
|
@@ -50,7 +64,8 @@ module Aws::SSMContacts
|
|
50
64
|
:contact_channel_id,
|
51
65
|
:accept_type,
|
52
66
|
:note,
|
53
|
-
:accept_code
|
67
|
+
:accept_code,
|
68
|
+
:accept_code_validation)
|
54
69
|
SENSITIVE = []
|
55
70
|
include Aws::Structure
|
56
71
|
end
|
@@ -59,7 +74,7 @@ module Aws::SSMContacts
|
|
59
74
|
#
|
60
75
|
class AcceptPageResult < Aws::EmptyStructure; end
|
61
76
|
|
62
|
-
# You don't have sufficient access to perform this
|
77
|
+
# You don't have sufficient access to perform this operation.
|
63
78
|
#
|
64
79
|
# @!attribute [rw] message
|
65
80
|
# @return [String]
|
@@ -343,7 +358,7 @@ module Aws::SSMContacts
|
|
343
358
|
# @return [Boolean]
|
344
359
|
#
|
345
360
|
# @!attribute [rw] idempotency_token
|
346
|
-
# A token ensuring that the
|
361
|
+
# A token ensuring that the operation is called only once with the
|
347
362
|
# specified details.
|
348
363
|
#
|
349
364
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -364,7 +379,7 @@ module Aws::SSMContacts
|
|
364
379
|
end
|
365
380
|
|
366
381
|
# @!attribute [rw] contact_channel_arn
|
367
|
-
# The ARN of the contact channel.
|
382
|
+
# The Amazon Resource Name (ARN) of the contact channel.
|
368
383
|
# @return [String]
|
369
384
|
#
|
370
385
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/CreateContactChannelResult AWS API Documentation
|
@@ -436,7 +451,7 @@ module Aws::SSMContacts
|
|
436
451
|
# @return [Array<Types::Tag>]
|
437
452
|
#
|
438
453
|
# @!attribute [rw] idempotency_token
|
439
|
-
# A token ensuring that the
|
454
|
+
# A token ensuring that the operation is called only once with the
|
440
455
|
# specified details.
|
441
456
|
#
|
442
457
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -469,7 +484,7 @@ module Aws::SSMContacts
|
|
469
484
|
include Aws::Structure
|
470
485
|
end
|
471
486
|
|
472
|
-
# The
|
487
|
+
# The operation failed to due an encryption key error.
|
473
488
|
#
|
474
489
|
# @!attribute [rw] message
|
475
490
|
# @return [String]
|
@@ -1527,7 +1542,8 @@ module Aws::SSMContacts
|
|
1527
1542
|
# }
|
1528
1543
|
#
|
1529
1544
|
# @!attribute [rw] duration_in_minutes
|
1530
|
-
# The time to wait until beginning the next stage.
|
1545
|
+
# The time to wait until beginning the next stage. The duration can
|
1546
|
+
# only be set to 0 if a target is specified.
|
1531
1547
|
# @return [Integer]
|
1532
1548
|
#
|
1533
1549
|
# @!attribute [rw] targets
|
@@ -1591,7 +1607,7 @@ module Aws::SSMContacts
|
|
1591
1607
|
# @return [String]
|
1592
1608
|
#
|
1593
1609
|
# @!attribute [rw] idempotency_token
|
1594
|
-
# A token ensuring that the
|
1610
|
+
# A token ensuring that the operation is called only once with the
|
1595
1611
|
# specified details.
|
1596
1612
|
#
|
1597
1613
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -1716,7 +1732,7 @@ module Aws::SSMContacts
|
|
1716
1732
|
#
|
1717
1733
|
class TagResourceResult < Aws::EmptyStructure; end
|
1718
1734
|
|
1719
|
-
# The contact or contact channel that
|
1735
|
+
# The contact or contact channel that's being engaged.
|
1720
1736
|
#
|
1721
1737
|
# @note When making an API call, you may pass Target
|
1722
1738
|
# data as a hash:
|
@@ -1850,7 +1866,7 @@ module Aws::SSMContacts
|
|
1850
1866
|
# @return [String]
|
1851
1867
|
#
|
1852
1868
|
# @!attribute [rw] name
|
1853
|
-
# The name of the contact channel
|
1869
|
+
# The name of the contact channel.
|
1854
1870
|
# @return [String]
|
1855
1871
|
#
|
1856
1872
|
# @!attribute [rw] delivery_address
|
@@ -1928,8 +1944,8 @@ module Aws::SSMContacts
|
|
1928
1944
|
#
|
1929
1945
|
class UpdateContactResult < Aws::EmptyStructure; end
|
1930
1946
|
|
1931
|
-
# The input fails to satisfy the constraints specified by an
|
1932
|
-
# service.
|
1947
|
+
# The input fails to satisfy the constraints specified by an Amazon Web
|
1948
|
+
# Services service.
|
1933
1949
|
#
|
1934
1950
|
# @!attribute [rw] message
|
1935
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.7.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-07
|
11
|
+
date: 2021-09-07 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.120.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.120.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
|
- - ">="
|