# 使用 AWS CLI 的 Incident Manager 联系人示例
<a name="cli_ssm-contacts_code_examples"></a>

以下代码示例演示如何通过将 AWS Command Line Interface与 Incident Manager 联系人结合使用，来执行操作和实现常见场景。

*操作是大型程序的代码摘录*，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景的上下文查看操作。

每个示例都包含一个指向完整源代码的链接，您可以从中找到有关如何在上下文中设置和运行代码的说明。

**Topics**
+ [操作](#actions)

## 操作
<a name="actions"></a>

### `accept-page`
<a name="ssm-contacts_AcceptPage_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_ActivateContactChannel_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_CommandName_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_CreateContactChannel_cli_topic"></a>

以下代码示例演示了如何使用 `create-contact-channel`。

**AWS 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"
}
```
有关更多信息，请参阅《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`
<a name="ssm-contacts_CreateContact_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_DeactivateContactChannel_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_DeleteContactChannel_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_DeleteContact_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_DescribeEngagement_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_DescribePage_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_GetContactChannel_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_GetContactPolicy_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_GetContact_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_ListContactChannels_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_ListContacts_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_ListEngagements_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_ListPageReceipts_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_ListPagesByContact_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_ListPagesByEngagement_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_ListTagsForResource_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_PutContactPolicy_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_SendActivationCode_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_StartEngagement_cli_topic"></a>

以下代码示例演示了如何使用 `start-engagement`。

**AWS CLI**  
**示例 1：寻呼联系人的联系频道**  
以下 `start-engagement` 将寻呼联系人的联系频道。发件人、主题、公共主题和公共内容都没有字段。Incident Manager 会将主题和内容发送到提供的语音或电子邮件联系频道。Incident Manager 会将公共主题和公共内容发送到提供的短信联系频道。发件人用于跟踪发起参与的对象。  

```
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`
<a name="ssm-contacts_StopEngagement_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_TagResource_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_UntagResource_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_UpdateContactChannel_cli_topic"></a>

以下代码示例演示了如何使用 `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`
<a name="ssm-contacts_UpdateContact_cli_topic"></a>

以下代码示例演示了如何使用 `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)。