本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
使用的事件管理器联系人示例 Amazon CLI
以下代码示例向您展示了如何使用事件管理器联系人来执行操作和实现常见场景。 Amazon Command Line Interface
操作是大型程序的代码摘录,必须在上下文中运行。您可以通过操作了解如何调用单个服务函数,还可以通过函数相关场景和跨服务示例的上下文查看操作。
场景是展示如何通过在同一服务中调用多个函数来完成特定任务任务的代码示例。
每个示例都包含一个指向的链接 GitHub,您可以在其中找到有关如何在上下文中设置和运行代码的说明。
主题
操作
以下代码示例演示如何使用 accept-page
。
- Amazon CLI
-
在参与期间接受页面和互动
以下
accept-page
示例使用发送到联系渠道的接受代码来接受页面。aws ssm-contacts accept-page \ --page-id "arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3" \ --accept-type READ \ --accept-code 425440
此命令不产生任何输出
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考AcceptPage
中的。
-
以下代码示例演示如何使用 activate-contact-channel
。
- Amazon CLI
-
激活联系人的联系渠道
以下
activate-contact-channel
示例激活联系渠道并将其作为事件的一部分使用。aws ssm-contacts activate-contact-channel \ --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d" \ --activation-code "466136"
此命令不生成任何输出。
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考ActivateContactChannel
中的。
-
以下代码示例演示如何使用 command-name
。
- Amazon CLI
-
删除联系人
以下
command-name
示例删除联系人。任何提及该联系人的升级计划都将无法再联系到该联系人。aws ssm-contacts delete-contact \ --contact-id "arn:aws:ssm-contacts:us-east-1:682428703967:contact/alejr"
此命令不生成任何输出。
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考CommandName
中的。
-
以下代码示例演示如何使用 create-contact-channel
。
- Amazon CLI
-
创建联系渠道
为联系人 Akua Mansa 创建短信类型的联系渠道。可以创建短信、电子邮件或语音类型的联系渠道。
aws ssm-contacts create-contact-channel \ --contact-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \ --name "akuas sms-test" \ --type SMS \ --delivery-address '{"SimpleAddress": "+15005550199"}'
输出:
{ "ContactChannelArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/02f506b9-ea5d-4764-af89-2daa793ff024" }
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考CreateContactChannel
中的。
-
以下代码示例演示如何使用 create-contact
。
- Amazon CLI
-
创建联系人
以下
create-contact
示例使用空白计划在您的环境中创建联系人。创建联系渠道后,可以更新计划。使用带有此 create-contact-channel 命令输出 ARN 的命令。为该联系人创建联系渠道后,使用 update-contact 更新计划。aws ssm-contacts create-contact \ --alias "akuam" \ --display-name "Akua Mansa" \ --type PERSONAL \ --plan '{"Stages": []}'
输出:
{ "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" }
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考CreateContact
中的。
-
以下代码示例演示如何使用 deactivate-contact-channel
。
- Amazon CLI
-
停用联系人频道
以下
deactivate-contact-channel
示例停用了联系渠道。停用联系人频道意味着在事件发生期间将不再对该联系人频道进行寻呼。您也可以随时使用activate-contact-channel
命令重新激活联系人频道。aws ssm-contacts deactivate-contact-channel \ --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"
此命令不生成任何输出。
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考DeactivateContactChannel
中的。
-
以下代码示例演示如何使用 delete-contact-channel
。
- Amazon CLI
-
删除联系人频道
以下
delete-contact-channel
示例删除了一个联系渠道。删除联系人频道可确保在事件发生期间不会对该联系人频道进行寻呼。aws ssm-contacts delete-contact-channel \ --contact-channel-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/13149bad-52ee-45ea-ae1e-45857f78f9b2"
此命令不生成任何输出。
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考DeleteContactChannel
中的。
-
以下代码示例演示如何使用 delete-contact
。
- Amazon CLI
-
删除联系人
以下
delete-contact
示例删除联系人。任何提及该联系人的升级计划都将无法再联系到该联系人。aws ssm-contacts delete-contact \ --contact-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr"
此命令不生成任何输出。
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考DeleteContact
中的。
-
以下代码示例演示如何使用 describe-engagement
。
- Amazon CLI
-
描述订婚的细节
以下
describe-engagement
示例列出了与联系人或升级计划互动的详细信息。主题和内容将发送到联系渠道。aws ssm-contacts describe-engagement \ --engagement-id "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"
输出:
{ "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", "Sender": "cli", "Subject": "cli-test", "Content": "Testing engagements via CLI", "PublicSubject": "cli-test", "PublicContent": "Testing engagements va CLI", "StartTime": "2021-05-18T18:25:41.151000+00:00" }
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考DescribeEngagement
中的。
-
以下代码示例演示如何使用 describe-page
。
- Amazon CLI
-
向联系渠道列出页面的详细信息
以下
describe-page
示例列出了联系渠道页面的详细信息。该页面将包括所提供的主题和内容。aws ssm-contacts describe-page \ --page-id "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93"
输出:
{ "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Sender": "cli", "Subject": "cli-test", "Content": "Testing engagements via CLI", "PublicSubject": "cli-test", "PublicContent": "Testing engagements va CLI", "SentTime": "2021-05-18T18:43:29.301000+00:00", "ReadTime": "2021-05-18T18:43:55.708000+00:00", "DeliveryTime": "2021-05-18T18:43:55.265000+00:00" }
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考DescribePage
中的。
-
以下代码示例演示如何使用 get-contact-channel
。
- Amazon CLI
-
列出联系渠道的详细信息
以下
get-contact-channel
示例列出了联系渠道的详细信息。aws ssm-contacts get-contact-channel \ --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"
输出:
{ "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", "Name": "akuas sms", "Type": "SMS", "DeliveryAddress": { "SimpleAddress": "+15005550199" }, "ActivationStatus": "ACTIVATED" }
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考GetContactChannel
中的。
-
以下代码示例演示如何使用 get-contact-policy
。
- Amazon CLI
-
列出联系人的资源政策
以下
get-contact-policy
示例列出了与指定联系人关联的资源策略。aws ssm-contacts get-contact-policy \ --contact-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"
输出:
{ "ContactArn": "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/*\"]}]}" }
有关更多信息,请参阅《事件管理器用户指南》中的使用共享联系人和响应计划。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考GetContactPolicy
中的。
-
以下代码示例演示如何使用 get-contact
。
- Amazon CLI
-
示例 1:描述联系计划
以下
get-contact
示例描述了联系人。aws ssm-contacts get-contact \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
输出:
{ "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Alias": "akuam", "DisplayName": "Akua Mansa", "Type": "PERSONAL", "Plan": { "Stages": [ { "DurationInMinutes": 5, "Targets": [ { "ChannelTargetInfo": { "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65", "RetryIntervalInMinutes": 1 } } ] }, { "DurationInMinutes": 5, "Targets": [ { "ChannelTargetInfo": { "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad", "RetryIntervalInMinutes": 1 } } ] }, { "DurationInMinutes": 5, "Targets": [ { "ChannelTargetInfo": { "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a", "RetryIntervalInMinutes": 1 } } ] } ] } }
示例 2:描述升级计划
以下
get-contact
示例描述了升级计划。aws ssm-contacts get-contact \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation"
输出:
{ "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", "Alias": "example_escalation", "DisplayName": "Example Escalation", "Type": "ESCALATION", "Plan": { "Stages": [ { "DurationInMinutes": 5, "Targets": [ { "ContactTargetInfo": { "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "IsEssential": true } } ] }, { "DurationInMinutes": 5, "Targets": [ { "ContactTargetInfo": { "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr", "IsEssential": false } } ] }, { "DurationInMinutes": 0, "Targets": [ { "ContactTargetInfo": { "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi", "IsEssential": false } } ] } ] } }
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考GetContact
中的。
-
以下代码示例演示如何使用 list-contact-channels
。
- Amazon CLI
-
列出联系人的联系渠道
以下
list-contact-channels
示例列出了指定联系人的可用联系渠道。aws ssm-contacts list-contact-channels \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
输出:
{ [ { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Name": "akuas email", "Type": "EMAIL", "DeliveryAddress": { "SimpleAddress": "akuam@example.com" }, "ActivationStatus": "NOT_ACTIVATED" }, { "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Name": "akuas sms", "Type": "SMS", "DeliveryAddress": { "SimpleAddress": "+15005550100" }, "ActivationStatus": "ACTIVATED" } ] }
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考ListContactChannels
中的。
-
以下代码示例演示如何使用 list-contacts
。
- Amazon CLI
-
列出所有升级计划和联系人
以下
list-contacts
示例列出了您账户中的联系人和升级计划。aws ssm-contacts list-contacts
输出:
{ "Contacts": [ { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Alias": "akuam", "DisplayName": "Akua Mansa", "Type": "PERSONAL" }, { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr", "Alias": "alejr", "DisplayName": "Alejandro Rosalez", "Type": "PERSONAL" }, { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi", "Alias": "anasi", "DisplayName": "Ana Carolina Silva", "Type": "PERSONAL" }, { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", "Alias": "example_escalation", "DisplayName": "Example Escalation", "Type": "ESCALATION" } ] }
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考ListContacts
中的。
-
以下代码示例演示如何使用 list-engagements
。
- Amazon CLI
-
列出所有参与情况
以下
list-engagements
示例列出了升级计划和联系人的参与情况。您还可以列出单个事件的参与度。aws ssm-contacts list-engagements
输出:
{ "Engagements": [ { "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/91792571-0b53-4821-9f73-d25d13d9e529", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Sender": "cli", "StartTime": "2021-05-18T20:37:50.300000+00:00" }, { "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Sender": "cli", "StartTime": "2021-05-18T18:40:26.666000+00:00" }, { "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", "Sender": "cli", "StartTime": "2021-05-18T18:25:41.151000+00:00" }, { "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Sender": "cli", "StartTime": "2021-05-18T18:20:58.093000+00:00" } ] }
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考ListEngagements
中的。
-
以下代码示例演示如何使用 list-page-receipts
。
- Amazon CLI
-
列出页面收据
以下
command-name
示例列出了联系人是否收到页面。aws ssm-contacts list-page-receipts \ --page-id "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3"
输出:
{ "Receipts": [ { "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", "ReceiptType": "DELIVERED", "ReceiptInfo": "425440", "ReceiptTime": "2021-05-18T20:42:57.485000+00:00" }, { "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", "ReceiptType": "READ", "ReceiptInfo": "425440", "ReceiptTime": "2021-05-18T20:42:57.907000+00:00" }, { "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", "ReceiptType": "SENT", "ReceiptInfo": "SM6656c19132f1465f9c9c1123a5dde7c9", "ReceiptTime": "2021-05-18T20:40:52.962000+00:00" } ] }
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考ListPageReceipts
中的。
-
以下代码示例演示如何使用 list-pages-by-contact
。
- Amazon CLI
-
按联系人列出页面
以下
list-pages-by-contact
示例列出了指定联系人的所有页面。aws ssm-contacts list-pages-by-contact \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
输出:
{ "Pages": [ { "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Sender": "cli", "SentTime": "2021-05-18T18:43:29.301000+00:00", "DeliveryTime": "2021-05-18T18:43:55.265000+00:00", "ReadTime": "2021-05-18T18:43:55.708000+00:00" } ] }
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考ListPagesByContact
中的。
-
以下代码示例演示如何使用 list-pages-by-engagement
。
- Amazon CLI
-
要列出要联系渠道的页面,请从互动开始。
以下
list-pages-by-engagement
示例列出了在参与已定义的互动计划时出现的页面。aws ssm-contacts list-pages-by-engagement \ --engagement-id "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0"
输出:
{ "Pages": [ { "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Sender": "cli", "SentTime": "2021-05-18T18:40:27.245000+00:00" } ] }
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考ListPagesByEngagement
中的。
-
以下代码示例演示如何使用 list-tags-for-resource
。
- Amazon CLI
-
列出联系人的标签
以下
list-tags-for-resource
示例列出了指定联系人的标签。aws ssm-contacts list-tags-for-resource \ --resource-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"
输出:
{ "Tags": [ { "Key": "group1", "Value": "1" } ] }
有关更多信息,请参阅《事件管理器用户指南》中的标记。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考ListTagsForResource
中的。
-
以下代码示例演示如何使用 put-contact-policy
。
- Amazon CLI
-
共享联系人和参与度
以下
put-contact-policy
示例向联系人 Akua 添加资源政策,该策略与委托人共享联系和相关互动。aws ssm-contacts 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\/*\"]}]}"
此命令不生成任何输出。
有关更多信息,请参阅《事件管理器用户指南》中的使用共享联系人和响应计划。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考PutContactPolicy
中的。
-
以下代码示例演示如何使用 send-activation-code
。
- Amazon CLI
-
发送激活码
以下
send-activation-code
示例向指定的联系渠道发送激活码和消息。aws ssm-contacts send-activation-code \ --contact-channel-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/8ddae2d1-12c8-4e45-b852-c8587266c400"
此命令不生成任何输出。
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考SendActivationCode
中的。
-
以下代码示例演示如何使用 start-engagement
。
- Amazon CLI
-
示例 1:拨打联系人的联系渠道
以下
start-engagement
页面联系人的联系渠道。发件人、主题、公共主题和公共内容都没有字段。事件管理器将主题和内容发送到提供的语音或电子邮件联系渠道。事件管理器将公共主题和公共内容发送到提供的短信联系渠道。发送者用于跟踪谁开始了互动。aws ssm-contacts start-engagement \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" \ --sender "cli" \ --subject "cli-test" \ --content "Testing engagements via CLI" \ --public-subject "cli-test" \ --public-content "Testing engagements va CLI"
输出:
{ "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f" }
有关更多信息,请参阅事件管理器用户指南中的联系人。
示例 2:在提供的升级计划中呼叫联系人。
以下内容通过升级计划
start-engagement
吸引联系人。每位联系人都会根据他们的参与计划进行寻呼。aws ssm-contacts start-engagement \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation" \ --sender "cli" \ --subject "cli-test" \ --content "Testing engagements via CLI" \ --public-subject "cli-test" \ --public-content "Testing engagements va CLI"
输出:
{ "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356" }
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考StartEngagement
中的。
-
以下代码示例演示如何使用 stop-engagement
。
- Amazon CLI
-
停止互动
以下
stop-engagement
示例阻止互动向更多联系人和联系人渠道传呼。aws ssm-contacts stop-engagement \ --engagement-id "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"
此命令不生成任何输出。
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考StopEngagement
中的。
-
以下代码示例演示如何使用 tag-resource
。
- Amazon CLI
-
为联系人添加标签
以下
tag-resource
示例使用提供的标签键值对为指定的联系人添加标签。aws ssm-contacts tag-resource \ --resource-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \ --tags '[{"Key":"group1","Value":"1"}]'
此命令不生成任何输出。
有关更多信息,请参阅《事件管理器用户指南》中的标记。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考TagResource
中的。
-
以下代码示例演示如何使用 untag-resource
。
- Amazon CLI
-
从联系人中移除标签
以下
untag-resource
示例从指定联系人中删除 group1 标签。aws ssm-contacts untag-resource \ --resource-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \ --tag-keys "group1"
此命令不生成任何输出。
有关更多信息,请参阅《事件管理器用户指南》中的标记。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考UntagResource
中的。
-
以下代码示例演示如何使用 update-contact-channel
。
- Amazon CLI
-
更新联系渠道
以下
update-contact-channel
示例更新了联系渠道的名称和收货地址。aws ssm-contacts update-contact-channel \ --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad" \ --name "akuas voice channel" \ --delivery-address '{"SimpleAddress": "+15005550198"}'
此命令不生成任何输出。
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考UpdateContactChannel
中的。
-
以下代码示例演示如何使用 update-contact
。
- Amazon CLI
-
更新联系人参与计划
以下
update-contact
示例更新了联系人 Akua 的参与计划,使其包括三种类型的联系渠道。这是在为 Akua 创建联系渠道之后完成的。aws ssm-contacts update-contact \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" \ --plan '{"Stages": [{"DurationInMinutes": 5, "Targets": [{"ChannelTargetInfo": {"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65","RetryIntervalInMinutes": 1 }}]}, {"DurationInMinutes": 5, "Targets": [{"ChannelTargetInfo":{"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad", "RetryIntervalInMinutes": 1}}]}, {"DurationInMinutes": 5, "Targets": [{"ChannelTargetInfo": {"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a","RetryIntervalInMinutes": 1 }}]}]}'
此命令不生成任何输出。
有关更多信息,请参阅事件管理器用户指南中的联系人。
-
有关 API 的详细信息,请参阅Amazon CLI 命令参考UpdateContact
中的。
-