aws-sdk-ssmcontacts 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35202afd55eb94c576336a417cffb342b26b86c9fe1a89845ca597425cefcd47
-  data.tar.gz: a4d8bb3265092e120ad15589d59a0dc628c8efdd84323436b77f5ea0c5f2b0a2
+  metadata.gz: b7851ff1d5f57fdc10b884d98fbda1b8711364def0747d5dcf3566a5d6f5d435
+  data.tar.gz: 6351b3eeb5696b538b415f0873db35695e9dcfbc48e82bc30ab51be548042984
 SHA512:
-  metadata.gz: '08cf3194aeaf672970948473308e6bff238314f4af1065d4e1a2698bbad6920283cbd4740130384a5b064baa5b2eaf78b16a1f7b237469c770985b37a6e53458'
-  data.tar.gz: 17c02c7dc8bae3c57965cbb9537f70cfbe32aab9d5f48c11264f6ecba82f0f2ae4b3d7d85ded17ea9b05985df56632227b9fe918c906fc1d8f8573007e64590e
+  metadata.gz: a4616239d2d939895d7919a4a97f81342c9370e53247f65debd74ac34ed512c6711710484b6ae1ac604772465fb785b4a05619d5e339e0a69aecffdc649ee22c
+  data.tar.gz: 1da3bb4aaba6ebc6eadd6c98fad98e41f2ad9e638a7d5b95bf5536ee4c20f03245e599d9713256039c19bf4b5e02bd0c7d9f326261ec1e86fc03791b6764d91f

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.7.0 (2021-09-07)
+------------------
+
+* Feature - Added SDK examples for SSM-Contacts.
+
 1.6.0 (2021-09-01)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.6.0
+1.7.0

data/lib/aws-sdk-ssmcontacts/client.rb

@@ -369,6 +369,21 @@ module Aws::SSMContacts
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To accept a page during and engagement
+    #
+    #   # The following accept-page operation uses an accept code sent to the contact channel to accept a page.
+    #
+    #   resp = client.accept_page({
+    #     accept_code: "425440", 
+    #     accept_type: "READ", 
+    #     page_id: "arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.accept_page({
@@ -401,6 +416,20 @@ module Aws::SSMContacts
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: Activate a contact's contact channel
+    #
+    #   # The following activate-contact-channel example activates a contact channel and makes it usable as part of an incident.
+    #
+    #   resp = client.activate_contact_channel({
+    #     activation_code: "466136", 
+    #     contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.activate_contact_channel({
@@ -442,7 +471,7 @@ module Aws::SSMContacts
     #   first Region of your replication set.
     #
     # @option params [String] :idempotency_token
-    #   A token ensuring that the action is called only once with the
+    #   A token ensuring that the operation is called only once with the
     #   specified details.
     #
     #   **A suitable default value is auto-generated.** You should normally
@@ -452,6 +481,28 @@ module Aws::SSMContacts
     #
     #   * {Types::CreateContactResult#contact_arn #contact_arn} => String
     #
+    #
+    # @example Example: To create a contact
+    #
+    #   # The following create-contact example creates a contact in your environment with a blank plan. The plan can be updated
+    #   # after creating contact channels. Use the create-contact-channel operation with the output ARN of this command. After you
+    #   # have created contact channels for this contact use update-contact to update the plan.
+    #
+    #   resp = client.create_contact({
+    #     alias: "akuam", 
+    #     display_name: "Akua Mansa", 
+    #     plan: {
+    #       stages: [
+    #       ], 
+    #     }, 
+    #     type: "PERSONAL", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_contact({
@@ -535,7 +586,7 @@ module Aws::SSMContacts
     #   until it has been activated.
     #
     # @option params [String] :idempotency_token
-    #   A token ensuring that the action is called only once with the
+    #   A token ensuring that the operation is called only once with the
     #   specified details.
     #
     #   **A suitable default value is auto-generated.** You should normally
@@ -545,6 +596,26 @@ module Aws::SSMContacts
     #
     #   * {Types::CreateContactChannelResult#contact_channel_arn #contact_channel_arn} => String
     #
+    #
+    # @example Example: To create a contact channel
+    #
+    #   # Creates a contact channel of type SMS for the contact Akua Mansa. Contact channels can be created of type SMS, EMAIL, or
+    #   # VOICE.
+    #
+    #   resp = client.create_contact_channel({
+    #     contact_id: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 
+    #     delivery_address: {
+    #       simple_address: "+15005550199", 
+    #     }, 
+    #     name: "akuas sms-test", 
+    #     type: "SMS", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     contact_channel_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/02f506b9-ea5d-4764-af89-2daa793ff024", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_contact_channel({
@@ -580,6 +651,21 @@ module Aws::SSMContacts
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To deactivate a contact channel
+    #
+    #   # The following ``deactivate-contact-channel`` example deactivates a contact channel. Deactivating a contact channel means
+    #   # the contact channel will no longer be paged during an incident. You can also reactivate a contact channel at any time
+    #   # using the activate-contact-channel operation.
+    #
+    #   resp = client.deactivate_contact_channel({
+    #     contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.deactivate_contact_channel({
@@ -606,6 +692,20 @@ module Aws::SSMContacts
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To delete a contact
+    #
+    #   # The following delete-contact example deletes a contact. The contact will no longer be reachable from any escalation plan
+    #   # that refers to them.
+    #
+    #   resp = client.delete_contact({
+    #     contact_id: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.delete_contact({
@@ -632,6 +732,20 @@ module Aws::SSMContacts
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To delete a contact channel
+    #
+    #   # The following delete-contact-channel example deletes a contact channel. Deleting a contact channel ensures the contact
+    #   # channel will not be paged during an incident.
+    #
+    #   resp = client.delete_contact_channel({
+    #     contact_channel_id: "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/13149bad-52ee-45ea-ae1e-45857f78f9b2", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.delete_contact_channel({
@@ -668,6 +782,28 @@ module Aws::SSMContacts
     #   * {Types::DescribeEngagementResult#start_time #start_time} => Time
     #   * {Types::DescribeEngagementResult#stop_time #stop_time} => Time
     #
+    #
+    # @example Example: To describe the details of an engagement
+    #
+    #   # The following describe-engagement example lists the details of an engagement to a contact or escalation plan. The
+    #   # subject and content are sent to the contact channels.
+    #
+    #   resp = client.describe_engagement({
+    #     engagement_id: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 
+    #     content: "Testing engagements", 
+    #     engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", 
+    #     public_content: "Testing engagements", 
+    #     public_subject: "test", 
+    #     sender: "tester", 
+    #     start_time: Time.parse("$2021-05-18T18:25:41.151000+00:00"), 
+    #     subject: "test", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_engagement({
@@ -716,6 +852,31 @@ module Aws::SSMContacts
     #   * {Types::DescribePageResult#read_time #read_time} => Time
     #   * {Types::DescribePageResult#delivery_time #delivery_time} => Time
     #
+    #
+    # @example Example: To list the details of a page to a contact channel
+    #
+    #   # The following describe-page example lists details of a page to a contact channel. The page will include the subject and
+    #   # content provided.
+    #
+    #   resp = client.describe_page({
+    #     page_id: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
+    #     content: "Testing engagements", 
+    #     delivery_time: Time.parse("2021-05-18T18:43:55.265000+00:00"), 
+    #     engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", 
+    #     page_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", 
+    #     public_content: "Testing engagements", 
+    #     public_subject: "test", 
+    #     read_time: Time.parse("2021-05-18T18:43:55.708000+00:00"), 
+    #     sender: "tester", 
+    #     sent_time: Time.parse("2021-05-18T18:43:29.301000+00:00"), 
+    #     subject: "test", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_page({
@@ -759,6 +920,113 @@ module Aws::SSMContacts
     #   * {Types::GetContactResult#type #type} => String
     #   * {Types::GetContactResult#plan #plan} => Types::Plan
     #
+    #
+    # @example Example: Example 1: To describe a contact plan
+    #
+    #   # The following get-contact example describes a contact.
+    #
+    #   resp = client.get_contact({
+    #     contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     alias: "akuam", 
+    #     contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
+    #     display_name: "Akua Mansa", 
+    #     plan: {
+    #       stages: [
+    #         {
+    #           duration_in_minutes: 5, 
+    #           targets: [
+    #             {
+    #               channel_target_info: {
+    #                 contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65", 
+    #                 retry_interval_in_minutes: 1, 
+    #               }, 
+    #             }, 
+    #           ], 
+    #         }, 
+    #         {
+    #           duration_in_minutes: 5, 
+    #           targets: [
+    #             {
+    #               channel_target_info: {
+    #                 contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad", 
+    #                 retry_interval_in_minutes: 1, 
+    #               }, 
+    #             }, 
+    #           ], 
+    #         }, 
+    #         {
+    #           duration_in_minutes: 5, 
+    #           targets: [
+    #             {
+    #               channel_target_info: {
+    #                 contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a", 
+    #                 retry_interval_in_minutes: 1, 
+    #               }, 
+    #             }, 
+    #           ], 
+    #         }, 
+    #       ], 
+    #     }, 
+    #     type: "PERSONAL", 
+    #   }
+    #
+    # @example Example: Example 2: To describe an escalation plan
+    #
+    #   # The following get-contact example describes an escalation plan.
+    #
+    #   resp = client.get_contact({
+    #     contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     alias: "example_escalation", 
+    #     contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 
+    #     display_name: "Example Escalation Plan", 
+    #     plan: {
+    #       stages: [
+    #         {
+    #           duration_in_minutes: 5, 
+    #           targets: [
+    #             {
+    #               contact_target_info: {
+    #                 contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
+    #                 is_essential: true, 
+    #               }, 
+    #             }, 
+    #           ], 
+    #         }, 
+    #         {
+    #           duration_in_minutes: 5, 
+    #           targets: [
+    #             {
+    #               contact_target_info: {
+    #                 contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr", 
+    #                 is_essential: false, 
+    #               }, 
+    #             }, 
+    #           ], 
+    #         }, 
+    #         {
+    #           duration_in_minutes: 0, 
+    #           targets: [
+    #             {
+    #               contact_target_info: {
+    #                 contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi", 
+    #                 is_essential: false, 
+    #               }, 
+    #             }, 
+    #           ], 
+    #         }, 
+    #       ], 
+    #     }, 
+    #     type: "ESCALATION", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_contact({
@@ -803,6 +1071,27 @@ module Aws::SSMContacts
     #   * {Types::GetContactChannelResult#delivery_address #delivery_address} => Types::ContactChannelAddress
     #   * {Types::GetContactChannelResult#activation_status #activation_status} => String
     #
+    #
+    # @example Example: To list the details of a contact channel
+    #
+    #   # The following get-contact-channel example lists the details of a contact channel.
+    #
+    #   resp = client.get_contact_channel({
+    #     contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     activation_status: "ACTIVATED", 
+    #     contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
+    #     contact_channel_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
+    #     delivery_address: {
+    #       simple_address: "+15005550199", 
+    #     }, 
+    #     name: "akuas sms", 
+    #     type: "SMS", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_contact_channel({
@@ -838,6 +1127,21 @@ module Aws::SSMContacts
     #   * {Types::GetContactPolicyResult#contact_arn #contact_arn} => String
     #   * {Types::GetContactPolicyResult#policy #policy} => String
     #
+    #
+    # @example Example: To list the resource policies of a contact
+    #
+    #   # The following get-contact-policy example lists the resource policies associated with the specified contact.
+    #
+    #   resp = client.get_contact_policy({
+    #     contact_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     contact_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 
+    #     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/*\"]}]}", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_contact_policy({
@@ -876,6 +1180,31 @@ module Aws::SSMContacts
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
+    #
+    # @example Example: To list the contact channels of a contact
+    #
+    #   # The following list-contact-channels example lists the available contact channels of the specified contact.
+    #
+    #   resp = client.list_contact_channels({
+    #     contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     contact_channels: [
+    #       {
+    #         activation_status: "ACTIVATED", 
+    #         contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
+    #         contact_channel_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
+    #         delivery_address: {
+    #           simple_address: "+15005550100", 
+    #         }, 
+    #         name: "akuas sms", 
+    #         type: "SMS", 
+    #       }, 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_contact_channels({
@@ -928,6 +1257,44 @@ module Aws::SSMContacts
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
+    #
+    # @example Example: To list all escalation plans and contacts
+    #
+    #   # The following list-contacts example lists the contacts and escalation plans in your account.
+    #
+    #   resp = client.list_contacts({
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     contacts: [
+    #       {
+    #         alias: "akuam", 
+    #         contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
+    #         display_name: "Akua Mansa", 
+    #         type: "PERSONAL", 
+    #       }, 
+    #       {
+    #         alias: "alejr", 
+    #         contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr", 
+    #         display_name: "Alejandro Rosalez", 
+    #         type: "PERSONAL", 
+    #       }, 
+    #       {
+    #         alias: "anasi", 
+    #         contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi", 
+    #         display_name: "Ana Carolina Silva", 
+    #         type: "PERSONAL", 
+    #       }, 
+    #       {
+    #         alias: "example_escalation", 
+    #         contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 
+    #         display_name: "Example Escalation", 
+    #         type: "ESCALATION", 
+    #       }, 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_contacts({
@@ -977,6 +1344,45 @@ module Aws::SSMContacts
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
+    #
+    # @example Example: To list all engagements
+    #
+    #   # The following list-engagements example lists engagements to escalation plans and contacts. You can also list engagements
+    #   # for a single incident.
+    #
+    #   resp = client.list_engagements({
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     engagements: [
+    #       {
+    #         contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
+    #         engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/91792571-0b53-4821-9f73-d25d13d9e529", 
+    #         sender: "cli", 
+    #         start_time: Time.parse("2021-05-18T20:37:50.300000+00:00"), 
+    #       }, 
+    #       {
+    #         contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
+    #         engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", 
+    #         sender: "cli", 
+    #         start_time: Time.parse("2021-05-18T18:40:26.666000+00:00"), 
+    #       }, 
+    #       {
+    #         contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 
+    #         engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", 
+    #         sender: "cli", 
+    #         start_time: Time.parse("2021-05-18T18:25:41.151000+00:00"), 
+    #       }, 
+    #       {
+    #         contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
+    #         engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f", 
+    #         sender: "cli", 
+    #         start_time: Time.parse("2021-05-18T18:20:58.093000+00:00"), 
+    #       }, 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_engagements({
@@ -1029,6 +1435,39 @@ module Aws::SSMContacts
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
+    #
+    # @example Example: To list page receipts
+    #
+    #   # The following command-name example lists whether a page was received or not by a contact.
+    #
+    #   resp = client.list_page_receipts({
+    #     page_id: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     receipts: [
+    #       {
+    #         contact_channel_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
+    #         receipt_info: "425440", 
+    #         receipt_time: Time.parse("2021-05-18T20:42:57.485000+00:00"), 
+    #         receipt_type: "DELIVERED", 
+    #       }, 
+    #       {
+    #         contact_channel_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
+    #         receipt_info: "425440", 
+    #         receipt_time: Time.parse("2021-05-18T20:42:57.907000+00:00"), 
+    #         receipt_type: "READ", 
+    #       }, 
+    #       {
+    #         contact_channel_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
+    #         receipt_info: "SM6656c19132f1465f9c9c1123a5dde7c9", 
+    #         receipt_time: Time.parse("2021-05-18T20:40:52.962000+00:00"), 
+    #         receipt_type: "SENT", 
+    #       }, 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_page_receipts({
@@ -1075,6 +1514,30 @@ module Aws::SSMContacts
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
+    #
+    # @example Example: To list pages by contact
+    #
+    #   # The following list-pages-by-contact example lists all pages to the specified contact.
+    #
+    #   resp = client.list_pages_by_contact({
+    #     contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     pages: [
+    #       {
+    #         contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
+    #         delivery_time: Time.parse("2021-05-18T18:43:55.265000+00:00"), 
+    #         engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", 
+    #         page_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", 
+    #         read_time: Time.parse("2021-05-18T18:43:55.708000+00:00"), 
+    #         sender: "cli", 
+    #         sent_time: Time.parse("2021-05-18T18:43:29.301000+00:00"), 
+    #       }, 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_pages_by_contact({
@@ -1125,6 +1588,28 @@ module Aws::SSMContacts
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
+    #
+    # @example Example: To list pages to contact channels started from an engagement.
+    #
+    #   # The following list-pages-by-engagement example lists the pages that occurred while engaging the defined engagement plan.
+    #
+    #   resp = client.list_pages_by_engagement({
+    #     engagement_id: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     pages: [
+    #       {
+    #         contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
+    #         engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", 
+    #         page_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", 
+    #         sender: "cli", 
+    #         sent_time: Time.parse("2021-05-18T18:40:27.245000+00:00"), 
+    #       }, 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_pages_by_engagement({
@@ -1164,6 +1649,25 @@ module Aws::SSMContacts
     #
     #   * {Types::ListTagsForResourceResult#tags #tags} => Array<Types::Tag>
     #
+    #
+    # @example Example: To list tags for a contact
+    #
+    #   # The following list-tags-for-resource example lists the tags of the specified contact.
+    #
+    #   resp = client.list_tags_for_resource({
+    #     resource_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     tags: [
+    #       {
+    #         key: "group1", 
+    #         value: "1", 
+    #       }, 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_tags_for_resource({
@@ -1195,6 +1699,21 @@ module Aws::SSMContacts
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To share a contact and engagements
+    #
+    #   # The following put-contact-policy example adds a resource policy to the contact Akua that shares the contact and related
+    #   # engagements with the principal.
+    #
+    #   resp = client.put_contact_policy({
+    #     contact_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 
+    #     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/*\"]}]}", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.put_contact_policy({
@@ -1213,7 +1732,7 @@ module Aws::SSMContacts
 
     # Sends an activation code to a contact channel. The contact can use
     # this code to activate the contact channel in the console or with the
-    # `ActivateChannel` action. Incident Manager can't engage a contact
+    # `ActivateChannel` operation. Incident Manager can't engage a contact
     # channel until it has been activated.
     #
     # @option params [required, String] :contact_channel_id
@@ -1221,6 +1740,19 @@ module Aws::SSMContacts
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To send an activation code
+    #
+    #   # The following send-activation-code example sends an activation code and message to the specified contact channel.
+    #
+    #   resp = client.send_activation_code({
+    #     contact_channel_id: "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/8ddae2d1-12c8-4e45-b852-c8587266c400", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.send_activation_code({
@@ -1265,7 +1797,7 @@ module Aws::SSMContacts
     #   The ARN of the incident that the engagement is part of.
     #
     # @option params [String] :idempotency_token
-    #   A token ensuring that the action is called only once with the
+    #   A token ensuring that the operation is called only once with the
     #   specified details.
     #
     #   **A suitable default value is auto-generated.** You should normally
@@ -1275,6 +1807,47 @@ module Aws::SSMContacts
     #
     #   * {Types::StartEngagementResult#engagement_arn #engagement_arn} => String
     #
+    #
+    # @example Example: Example 1: To page a contact's contact channels
+    #
+    #   # The following start-engagement pages contact's contact channels. Sender, subject, public-subject, and public-content are
+    #   # all free from fields. Incident Manager sends the subject and content to the provided VOICE or EMAIL contact channels.
+    #   # Incident Manager sends the public-subject and public-content to the provided SMS contact channels. Sender is used to
+    #   # track who started the engagement.
+    #
+    #   resp = client.start_engagement({
+    #     contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
+    #     content: "Testing engagements", 
+    #     public_content: "Testing engagements", 
+    #     public_subject: "test", 
+    #     sender: "tester", 
+    #     subject: "test", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f", 
+    #   }
+    #
+    # @example Example: Example 2: To page a contact in the provided escalation plan.
+    #
+    #   # The following start-engagement engages contact's through an escalation plan. Each contact is paged according to their
+    #   # engagement plan.
+    #
+    #   resp = client.start_engagement({
+    #     contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 
+    #     content: "Testing engagements", 
+    #     public_content: "Testing engagements", 
+    #     public_subject: "test", 
+    #     sender: "tester", 
+    #     subject: "test", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.start_engagement({
@@ -1312,6 +1885,19 @@ module Aws::SSMContacts
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To stop an engagement
+    #
+    #   # The following stop-engagement example stops an engagement from paging further contacts and contact channels.
+    #
+    #   resp = client.stop_engagement({
+    #     engagement_id: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.stop_engagement({
@@ -1339,6 +1925,25 @@ module Aws::SSMContacts
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To tag a contact
+    #
+    #   # The following tag-resource example tags a specified contact with the provided tag key value pair.
+    #
+    #   resp = client.tag_resource({
+    #     resource_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 
+    #     tags: [
+    #       {
+    #         key: "group1", 
+    #         value: "1", 
+    #       }, 
+    #     ], 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.tag_resource({
@@ -1370,6 +1975,22 @@ module Aws::SSMContacts
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To remove tags from a contact
+    #
+    #   # The following untag-resource example removes the group1 tag from the specified contact.
+    #
+    #   resp = client.untag_resource({
+    #     resource_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 
+    #     tag_keys: [
+    #       "group1", 
+    #     ], 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.untag_resource({
@@ -1402,6 +2023,57 @@ module Aws::SSMContacts
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To update the engagement plan of contact
+    #
+    #   # The following update-contact example updates the engagement plan of the contact Akua to include the three types of
+    #   # contacts channels. This is done after creating contact channels for Akua.
+    #
+    #   resp = client.update_contact({
+    #     contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
+    #     plan: {
+    #       stages: [
+    #         {
+    #           duration_in_minutes: 5, 
+    #           targets: [
+    #             {
+    #               channel_target_info: {
+    #                 contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65", 
+    #                 retry_interval_in_minutes: 1, 
+    #               }, 
+    #             }, 
+    #           ], 
+    #         }, 
+    #         {
+    #           duration_in_minutes: 5, 
+    #           targets: [
+    #             {
+    #               channel_target_info: {
+    #                 contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad", 
+    #                 retry_interval_in_minutes: 1, 
+    #               }, 
+    #             }, 
+    #           ], 
+    #         }, 
+    #         {
+    #           duration_in_minutes: 5, 
+    #           targets: [
+    #             {
+    #               channel_target_info: {
+    #                 contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a", 
+    #                 retry_interval_in_minutes: 1, 
+    #               }, 
+    #             }, 
+    #           ], 
+    #         }, 
+    #       ], 
+    #     }, 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.update_contact({
@@ -1444,7 +2116,7 @@ module Aws::SSMContacts
     #   update.
     #
     # @option params [String] :name
-    #   The name of the contact channel
+    #   The name of the contact channel.
     #
     # @option params [Types::ContactChannelAddress] :delivery_address
     #   The details that Incident Manager uses when trying to engage the
@@ -1452,6 +2124,23 @@ module Aws::SSMContacts
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To update a contact channel
+    #
+    #   # The following update-contact-channel example updates the name and delivery address of a contact channel.
+    #
+    #   resp = client.update_contact_channel({
+    #     contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad", 
+    #     delivery_address: {
+    #       simple_address: "+15005550198", 
+    #     }, 
+    #     name: "akuas voice channel", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.update_contact_channel({
@@ -1484,7 +2173,7 @@ module Aws::SSMContacts
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-ssmcontacts'
-      context[:gem_version] = '1.6.0'
+      context[:gem_version] = '1.7.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-ssmcontacts/types.rb

@@ -74,7 +74,7 @@ module Aws::SSMContacts
     #
     class AcceptPageResult < Aws::EmptyStructure; end
 
-    # You don't have sufficient access to perform this action.
+    # You don't have sufficient access to perform this operation.
     #
     # @!attribute [rw] message
     #   @return [String]
@@ -358,7 +358,7 @@ module Aws::SSMContacts
     #   @return [Boolean]
     #
     # @!attribute [rw] idempotency_token
-    #   A token ensuring that the action is called only once with the
+    #   A token ensuring that the operation is called only once with the
     #   specified details.
     #
     #   **A suitable default value is auto-generated.** You should normally
@@ -379,7 +379,7 @@ module Aws::SSMContacts
     end
 
     # @!attribute [rw] contact_channel_arn
-    #   The ARN of the contact channel.
+    #   The Amazon Resource Name (ARN) of the contact channel.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/CreateContactChannelResult AWS API Documentation
@@ -451,7 +451,7 @@ module Aws::SSMContacts
     #   @return [Array<Types::Tag>]
     #
     # @!attribute [rw] idempotency_token
-    #   A token ensuring that the action is called only once with the
+    #   A token ensuring that the operation is called only once with the
     #   specified details.
     #
     #   **A suitable default value is auto-generated.** You should normally
@@ -484,7 +484,7 @@ module Aws::SSMContacts
       include Aws::Structure
     end
 
-    # The action failed to due an encryption key error.
+    # The operation failed to due an encryption key error.
     #
     # @!attribute [rw] message
     #   @return [String]
@@ -1607,7 +1607,7 @@ module Aws::SSMContacts
     #   @return [String]
     #
     # @!attribute [rw] idempotency_token
-    #   A token ensuring that the action is called only once with the
+    #   A token ensuring that the operation is called only once with the
     #   specified details.
     #
     #   **A suitable default value is auto-generated.** You should normally
@@ -1732,7 +1732,7 @@ module Aws::SSMContacts
     #
     class TagResourceResult < Aws::EmptyStructure; end
 
-    # The contact or contact channel that is being engaged.
+    # The contact or contact channel that's being engaged.
     #
     # @note When making an API call, you may pass Target
     #   data as a hash:
@@ -1866,7 +1866,7 @@ module Aws::SSMContacts
     #   @return [String]
     #
     # @!attribute [rw] name
-    #   The name of the contact channel
+    #   The name of the contact channel.
     #   @return [String]
     #
     # @!attribute [rw] delivery_address
@@ -1944,8 +1944,8 @@ module Aws::SSMContacts
     #
     class UpdateContactResult < Aws::EmptyStructure; end
 
-    # The input fails to satisfy the constraints specified by an AWS
-    # service.
+    # The input fails to satisfy the constraints specified by an Amazon Web
+    # Services service.
     #
     # @!attribute [rw] message
     #   @return [String]

data/lib/aws-sdk-ssmcontacts.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-ssmcontacts/customizations'
 # @!group service
 module Aws::SSMContacts
 
-  GEM_VERSION = '1.6.0'
+  GEM_VERSION = '1.7.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-ssmcontacts
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-01 00:00:00.000000000 Z
+date: 2021-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core