事件管理員聯絡範例使用 AWS CLI - AWS Command Line Interface

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

事件管理員聯絡範例使用 AWS CLI

下列程式碼範例說明如何使用「事件管理員連絡人」來執行動作及實作常見案例。 AWS Command Line Interface

Actions 是大型程式的程式碼摘錄,必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數,但您可以在其相關情境和跨服務範例中查看內容中的動作。

Scenarios (案例) 是向您展示如何呼叫相同服務中的多個函數來完成特定任務的程式碼範例。

每個範例都包含一個連結 GitHub,您可以在其中找到如何在內容中設定和執行程式碼的指示。

主題

動作

下列程式碼範例會示範如何使用accept-page

AWS 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 詳細資訊,請參閱AWS CLI 命令參考AcceptPage中的。

下列程式碼範例會示範如何使用activate-contact-channel

AWS 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"

此命令不會產生輸出。

如需詳細資訊,請參閱事件管理員使用指南中的聯絡人

下列程式碼範例會示範如何使用command-name

AWS CLI

若要刪除連絡人

下列command-name範例會刪除連絡人。您將無法再從任何參考這些連絡人的升級計畫連絡人。

aws ssm-contacts delete-contact \ --contact-id "arn:aws:ssm-contacts:us-east-1:682428703967:contact/alejr"

此命令不會產生輸出。

如需詳細資訊,請參閱事件管理員使用指南中的聯絡人

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考CommandName中的。

下列程式碼範例會示範如何使用create-contact-channel

AWS CLI

若要建立聯絡人管道

為聯繫人創建 SMS 類型的聯繫人渠道阿卡曼薩。您可以建立簡訊、電子郵件或語音類型的聯絡人管道。

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" }

如需詳細資訊,請參閱事件管理員使用指南中的聯絡人

下列程式碼範例會示範如何使用create-contact

AWS CLI

若要建立連絡人

下列create-contact範例會在您的環境中建立具有空白計劃的連絡人。計劃可以在創建聯繫渠道後更新。使用該 create-contact-channel 命令與此命令的輸出 ARN 一起使用。建立此聯絡人的聯絡管道後,請使用更新聯絡人來更新計劃。

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 詳細資訊,請參閱AWS CLI 命令參考CreateContact中的。

下列程式碼範例會示範如何使用deactivate-contact-channel

AWS 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"

此命令不會產生輸出。

如需詳細資訊,請參閱事件管理員使用指南中的聯絡人

下列程式碼範例會示範如何使用delete-contact-channel

AWS 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"

此命令不會產生輸出。

如需詳細資訊,請參閱事件管理員使用指南中的聯絡人

下列程式碼範例會示範如何使用delete-contact

AWS CLI

若要刪除連絡人

下列delete-contact範例會刪除連絡人。您將無法再從任何參考這些連絡人的升級計畫連絡人。

aws ssm-contacts delete-contact \ --contact-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr"

此命令不會產生輸出。

如需詳細資訊,請參閱事件管理員使用指南中的聯絡人

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考DeleteContact中的。

下列程式碼範例會示範如何使用describe-engagement

AWS 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" }

如需詳細資訊,請參閱事件管理員使用指南中的聯絡人

下列程式碼範例會示範如何使用describe-page

AWS 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 詳細資訊,請參閱AWS CLI 命令參考DescribePage中的。

下列程式碼範例會示範如何使用get-contact-channel

AWS 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" }

如需詳細資訊,請參閱事件管理員使用指南中的聯絡人

下列程式碼範例會示範如何使用get-contact-policy

AWS 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 詳細資訊,請參閱AWS CLI 命令參考GetContactPolicy中的。

下列程式碼範例會示範如何使用get-contact

AWS 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 詳細資訊,請參閱AWS CLI 命令參考GetContact中的。

下列程式碼範例會示範如何使用list-contact-channels

AWS 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" } ] }

如需詳細資訊,請參閱事件管理員使用指南中的聯絡人

下列程式碼範例會示範如何使用list-contacts

AWS 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 詳細資訊,請參閱AWS CLI 命令參考ListContacts中的。

下列程式碼範例會示範如何使用list-engagements

AWS 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 詳細資訊,請參閱AWS CLI 命令參考ListEngagements中的。

下列程式碼範例會示範如何使用list-page-receipts

AWS 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 詳細資訊,請參閱AWS CLI 命令參考ListPageReceipts中的。

下列程式碼範例會示範如何使用list-pages-by-contact

AWS 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" } ] }

如需詳細資訊,請參閱事件管理員使用指南中的聯絡人

下列程式碼範例會示範如何使用list-pages-by-engagement

AWS 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" } ] }

如需詳細資訊,請參閱事件管理員使用指南中的聯絡人

下列程式碼範例會示範如何使用list-tags-for-resource

AWS 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" } ] }

如需詳細資訊,請參閱事件管理員使用指南中的標記

下列程式碼範例會示範如何使用put-contact-policy

AWS CLI

分享聯絡人和參與

下列put-contact-policy範例會將資源原則新增至與主參與者共用連絡人和相關參與的聯絡人 Agua。

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 詳細資訊,請參閱AWS CLI 命令參考PutContactPolicy中的。

下列程式碼範例會示範如何使用send-activation-code

AWS 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"

此命令不會產生輸出。

如需詳細資訊,請參閱事件管理員使用指南中的聯絡人

下列程式碼範例會示範如何使用start-engagement

AWS CLI

範例 1:分頁連絡人的聯絡管道

以下start-engagement頁面聯繫人的聯繫渠道。寄件者、主旨、公開主旨和公開內容都不含欄位。事件管理員會將主旨和內容傳送至提供的語音或電子郵件聯絡管道。事件管理員會將公開主題和公開內容傳送至提供的 SMS 聯絡管道。傳送者是用來追蹤誰開始參與。

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 詳細資訊,請參閱AWS CLI 命令參考StartEngagement中的。

下列程式碼範例會示範如何使用stop-engagement

AWS 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 詳細資訊,請參閱AWS CLI 命令參考StopEngagement中的。

下列程式碼範例會示範如何使用tag-resource

AWS 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 詳細資訊,請參閱AWS CLI 命令參考TagResource中的。

下列程式碼範例會示範如何使用untag-resource

AWS 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 詳細資訊,請參閱AWS CLI 命令參考UntagResource中的。

下列程式碼範例會示範如何使用update-contact-channel

AWS 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"}'

此命令不會產生輸出。

如需詳細資訊,請參閱事件管理員使用指南中的聯絡人

下列程式碼範例會示範如何使用update-contact

AWS CLI

若要更新聯絡人的業務開發計劃,

下列update-contact範例會更新聯絡人 Agua 的參與計劃,以包含三種類型的聯絡人管道。這是在為 Agua 創建聯繫渠道後完成的。

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 詳細資訊,請參閱AWS CLI 命令參考UpdateContact中的。