# AWS CLI を使用した Incident Manager Contacts の例
<a name="cli_ssm-contacts_code_examples"></a>

次のコード例は、Incident Manager Contacts で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。

**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 の SMS タイプの連絡先チャネルを作成します。連絡先チャネルは、SMS、E メール、または音声のタイプで作成できます。  

```
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` の例では、エスカレーションプランと連絡先へのエンゲージメントを一覧表示します。1 つのインシデントのエンゲージメントを表示することもできます。  

```
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 は、提供された音声または E メールの連絡先チャネルに件名とコンテンツを送信します。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`
<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 のエンゲージメントプランを更新して、3 種類の連絡先チャネルを含めます。これは、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)」を参照してください。