本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# 使用 的 Incident Manager Contacts 範例 AWS CLI
下列程式碼範例示範如何使用 AWS Command Line Interface 搭配 Incident Manager Contacts 來執行動作和實作常見案例。
*Actions* 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數，但您可以在其相關情境中查看內容中的動作。
每個範例均包含完整原始碼的連結，您可在連結中找到如何設定和執行內容中程式碼的相關指示。
**Topics**
+ [動作](#actions)
## 動作
### `accept-page`
以下程式碼範例顯示如何使用 `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
```
此命令不會產生輸出。
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [AcceptPage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/accept-page.html)。
### `activate-contact-channel`
以下程式碼範例顯示如何使用 `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"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《*AWS CLI 命令參考*》中的 [ActivateContactChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/activate-contact-channel.html)。
### `command-name`
以下程式碼範例顯示如何使用 `command-name`。
**AWS CLI**
**刪除聯絡人**
下列 `command-name` 範例刪除聯絡人。任何涉及聯絡人的呈報計畫，都將無法再聯繫到該聯絡人。
```
aws ssm-contacts delete-contact \
--contact-id "arn:aws:ssm-contacts:us-east-1:682428703967:contact/alejr"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CommandName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/command-name.html)。
### `create-contact-channel`
以下程式碼範例顯示如何使用 `create-contact-channel`。
**AWS CLI**
**建立聯絡管道**
為聯絡人 Akua Mansa 建立 SMS 類型的聯絡管道。您可以建立 SMS、EMAIL 或 VOICE 類型的聯絡管道。
```
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"
}
```
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateContactChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/create-contact-channel.html)。
### `create-contact`
以下程式碼範例顯示如何使用 `create-contact`。
**AWS CLI**
**建立聯絡人**
下列 `create-contact` 範例會在您環境中使用空白計畫建立聯絡人。可在建立聯絡管道後更新計畫。搭配此命令的輸出 ARN 使用 create-contact-channel 命令。在您為此聯絡人建立聯絡管道之後，請使用 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"
}
```
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateContact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/create-contact.html)。
### `deactivate-contact-channel`
以下程式碼範例顯示如何使用 `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"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《*AWS CLI 命令參考*》中的 [DeactivateContactChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/deactivate-contact-channel.html)。
### `delete-contact-channel`
以下程式碼範例顯示如何使用 `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"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteContactChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/delete-contact-channel.html)。
### `delete-contact`
以下程式碼範例顯示如何使用 `delete-contact`。
**AWS CLI**
**刪除聯絡人**
下列 `delete-contact` 範例刪除聯絡人。任何涉及聯絡人的呈報計畫，都將無法再聯繫到該聯絡人。
```
aws ssm-contacts delete-contact \
--contact-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteContact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/delete-contact.html)。
### `describe-engagement`
以下程式碼範例顯示如何使用 `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"
}
```
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeEngagement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/describe-engagement.html)。
### `describe-page`
以下程式碼範例顯示如何使用 `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"
}
```
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribePage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/describe-page.html)。
### `get-contact-channel`
以下程式碼範例顯示如何使用 `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"
}
```
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetContactChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/get-contact-channel.html)。
### `get-contact-policy`
以下程式碼範例顯示如何使用 `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/*\"]}]}"
}
```
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[使用共用聯絡人和回應計劃](https://docs.aws.amazon.com/incident-manager/latest/userguide/sharing.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetContactPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/get-contact-policy.html)。
### `get-contact`
以下程式碼範例顯示如何使用 `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
}
}
]
}
]
}
}
```
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetContact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/get-contact.html)。
### `list-contact-channels`
以下程式碼範例顯示如何使用 `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"
}
]
}
```
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListContactChannels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-contact-channels.html)。
### `list-contacts`
以下程式碼範例顯示如何使用 `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"
}
]
}
```
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListContacts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-contacts.html)。
### `list-engagements`
以下程式碼範例顯示如何使用 `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"
}
]
}
```
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListEngagements](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-engagements.html)。
### `list-page-receipts`
以下程式碼範例顯示如何使用 `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"
}
]
}
```
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListPageReceipts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-page-receipts.html)。
### `list-pages-by-contact`
以下程式碼範例顯示如何使用 `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"
}
]
}
```
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListPagesByContact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-pages-by-contact.html)。
### `list-pages-by-engagement`
以下程式碼範例顯示如何使用 `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"
}
]
}
```
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListPagesByEngagement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-pages-by-engagement.html)。
### `list-tags-for-resource`
以下程式碼範例顯示如何使用 `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"
}
]
}
```
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[標記](https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-tags-for-resource.html)。
### `put-contact-policy`
以下程式碼範例顯示如何使用 `put-contact-policy`。
**AWS 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\/*\"]}]}"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[使用共用聯絡人和回應計劃](https://docs.aws.amazon.com/incident-manager/latest/userguide/sharing.html)。
+ 如需 API 詳細資訊，請參閱《*AWS CLI 命令參考*》中的 [PutContactPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/put-contact-policy.html)。
### `send-activation-code`
以下程式碼範例顯示如何使用 `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"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《*AWS CLI 命令參考*》中的 [SendActivationCode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/send-activation-code.html)。
### `start-engagement`
以下程式碼範例顯示如何使用 `start-engagement`。
**AWS CLI**
**範例 1：傳呼聯絡人的聯絡管道**
以下 `start-engagement` 頁面是聯絡人的聯絡管道。寄件者、主旨、公用主旨和公用內容都沒有欄位。Incident Manager 會將主旨和內容傳送至提供的 VOICE 或 EMAIL 聯絡管道。Incident Manager 會將公用主旨和公用內容傳送至提供的 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"
}
```
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
**範例 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"
}
```
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [StartEngagement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/start-engagement.html)。
### `stop-engagement`
以下程式碼範例顯示如何使用 `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"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [StopEngagement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/stop-engagement.html)。
### `tag-resource`
以下程式碼範例顯示如何使用 `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"}]'
```
此命令不會產生輸出。
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[標記](https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/tag-resource.html)。
### `untag-resource`
以下程式碼範例顯示如何使用 `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"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[標記](https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/untag-resource.html)。
### `update-contact-channel`
以下程式碼範例顯示如何使用 `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"}'
```
此命令不會產生輸出。
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdateContactChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/update-contact-channel.html)。
### `update-contact`
以下程式碼範例顯示如何使用 `update-contact`。
**AWS 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 }}]}]}'
```
此命令不會產生輸出。
如需詳細資訊，請參閱《*Incident Manager 使用者指南*》中的[聯絡案例](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdateContact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/update-contact.html)。