# AWS CLI를 사용한 Incident Manager 연락처 예시
다음 코드 예시에서는 Incident Manager 연락처와 함께 AWS Command Line Interface를 사용하여 작업을 수행하고 일반적인 시나리오를 구현하는 방법을 보여줍니다.
*작업*은 대규모 프로그램에서 발췌한 코드이며 컨텍스트에 맞춰 실행해야 합니다. 작업은 개별 서비스 함수를 직접적으로 호출하는 방법을 보여주며 관련 시나리오의 컨텍스트에 맞는 작업을 볼 수 있습니다.
각 예시에는 전체 소스 코드에 대한 링크가 포함되어 있으며, 여기에서 컨텍스트에 맞춰 코드를 설정하고 실행하는 방법에 대한 지침을 찾을 수 있습니다.
**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` 예시에서는 계획이 비어 있는 환경에 연락처를 생성합니다. 계획은 문의 채널을 생성한 후 업데이트할 수 있습니다. create-contact-channel 명령을 이 명령의 출력 ARN과 함께 사용합니다. 이 연락처의 문의 채널을 생성한 후 update-contact를 사용하여 계획을 업데이트합니다.
```
aws ssm-contacts create-contact \
--alias "akuam" \
--display-name "Akua Mansa" \
--type PERSONAL \
--plan '{"Stages": []}'
```
출력:
```
{
"ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
}
```
자세한 내용은 *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`는 연락처의 문의 채널을 호출합니다. sender, subject, public-subject 및 public-content에는 필드가 없습니다. Incident Manager는 제공된 VOICE 또는 EMAIL 문의 채널로 subject 및 content를 전송합니다. Incident Manager는 제공된 SMS 문의 채널로 public-subject 및 public-content를 전송합니다. sender는 상담을 시작한 사람을 추적하는 데 사용됩니다.
```
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)를 참조하세요.