を使用した Incident Manager Contacts の例 AWS CLI - AWS Command Line Interface

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

を使用した Incident Manager Contacts の例 AWS CLI

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

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

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

トピック

アクション

次のコード例は、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 ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスAcceptPage」の「」を参照してください。

次の例は、activate-contact-channel を使用する方法を説明しています。

AWS CLI

問い合わせの問い合わせチャネルをアクティブ化する

次のactivate-contact-channel例では、問い合わせチャネルをアクティブ化し、インシデントの一部として使用できます。

aws ssm-contacts activate-contact-channel \ --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d" \ --activation-code "466136"

このコマンドでは何も出力されません。

詳細については、「 Incident Manager ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスActivateContactChannel」の「」を参照してください。

次のコード例は、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 ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスCommandName」の「」を参照してください。

次のコード例は、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 ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateContactChannel」の「」を参照してください。

次の例は、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 ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateContact」の「」を参照してください。

次のコード例は、deactivate-contact-channel を使用する方法を示しています。

AWS CLI

問い合わせチャネルを非アクティブ化するには

次のdeactivate-contact-channel例では、問い合わせチャネルを非アクティブ化します。問い合わせチャネルを非アクティブ化すると、インシデント中に問い合わせチャネルがページングされなくなります。activate-contact-channel コマンドを使用して、いつでも問い合わせチャネルを再アクティブ化することもできます。

aws ssm-contacts deactivate-contact-channel \ --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"

このコマンドでは何も出力されません。

詳細については、「 Incident Manager ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeactivateContactChannel」の「」を参照してください。

次の例は、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 ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteContactChannel」の「」を参照してください。

次のコード例は、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 ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteContact」の「」を参照してください。

次のコード例は、describe-engagement を使用する方法を示しています。

AWS CLI

エンゲージメントの詳細を記述するには

次のdescribe-engagement例では、問い合わせまたはエスカレーションプランへのエンゲージメントの詳細を一覧表示します。件名とコンテンツは問い合わせチャネルに送信されます。

aws ssm-contacts describe-engagement \ --engagement-id "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"

出力:

{ "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", "Sender": "cli", "Subject": "cli-test", "Content": "Testing engagements via CLI", "PublicSubject": "cli-test", "PublicContent": "Testing engagements va CLI", "StartTime": "2021-05-18T18:25:41.151000+00:00" }

詳細については、「 Incident Manager ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribeEngagement」の「」を参照してください。

次のコード例は、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 ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribePage」の「」を参照してください。

次のコード例は、get-contact-channel を使用する方法を示しています。

AWS CLI

問い合わせチャネルの詳細を一覧表示するには

次のget-contact-channel例では、問い合わせチャネルの詳細を一覧表示します。

aws ssm-contacts get-contact-channel \ --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"

出力:

{ "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", "Name": "akuas sms", "Type": "SMS", "DeliveryAddress": { "SimpleAddress": "+15005550199" }, "ActivationStatus": "ACTIVATED" }

詳細については、「 Incident Manager ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetContactChannel」の「」を参照してください。

次の例は、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 ユーザーガイド」の「共有連絡先と対応計画の操作」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetContactPolicy」の「」を参照してください。

次のコード例は、get-contact を使用する方法を示しています。

AWS CLI

例 1: 問い合わせプランを記述するには

次のget-contact例では、問い合わせについて説明します。

aws ssm-contacts get-contact \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"

出力:

{ "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Alias": "akuam", "DisplayName": "Akua Mansa", "Type": "PERSONAL", "Plan": { "Stages": [ { "DurationInMinutes": 5, "Targets": [ { "ChannelTargetInfo": { "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65", "RetryIntervalInMinutes": 1 } } ] }, { "DurationInMinutes": 5, "Targets": [ { "ChannelTargetInfo": { "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad", "RetryIntervalInMinutes": 1 } } ] }, { "DurationInMinutes": 5, "Targets": [ { "ChannelTargetInfo": { "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a", "RetryIntervalInMinutes": 1 } } ] } ] } }

例 2: エスカレーションプランを記述するには

次のget-contact例では、エスカレーションプランについて説明します。

aws ssm-contacts get-contact \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation"

出力:

{ "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", "Alias": "example_escalation", "DisplayName": "Example Escalation", "Type": "ESCALATION", "Plan": { "Stages": [ { "DurationInMinutes": 5, "Targets": [ { "ContactTargetInfo": { "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "IsEssential": true } } ] }, { "DurationInMinutes": 5, "Targets": [ { "ContactTargetInfo": { "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr", "IsEssential": false } } ] }, { "DurationInMinutes": 0, "Targets": [ { "ContactTargetInfo": { "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi", "IsEssential": false } } ] } ] } }

詳細については、「 Incident Manager ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetContact」の「」を参照してください。

次の例は、list-contact-channels を使用する方法を説明しています。

AWS CLI

問い合わせの問い合わせチャネルを一覧表示するには

次のlist-contact-channels例は、指定された問い合わせで使用可能な問い合わせチャネルを一覧表示します。

aws ssm-contacts list-contact-channels \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"

出力:

{ [ { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Name": "akuas email", "Type": "EMAIL", "DeliveryAddress": { "SimpleAddress": "akuam@example.com" }, "ActivationStatus": "NOT_ACTIVATED" }, { "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Name": "akuas sms", "Type": "SMS", "DeliveryAddress": { "SimpleAddress": "+15005550100" }, "ActivationStatus": "ACTIVATED" } ] }

詳細については、「 Incident Manager ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスListContactChannels」の「」を参照してください。

次のコード例は、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 ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスListContacts」の「」を参照してください。

次の例は、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 ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスListEngagements」の「」を参照してください。

次のコード例は、list-page-receipts を使用する方法を示しています。

AWS CLI

ページ受信を一覧表示するには

次のcommand-name例は、問い合わせによってページが受信されたかどうかを示しています。

aws ssm-contacts list-page-receipts \ --page-id "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3"

出力:

{ "Receipts": [ { "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", "ReceiptType": "DELIVERED", "ReceiptInfo": "425440", "ReceiptTime": "2021-05-18T20:42:57.485000+00:00" }, { "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", "ReceiptType": "READ", "ReceiptInfo": "425440", "ReceiptTime": "2021-05-18T20:42:57.907000+00:00" }, { "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", "ReceiptType": "SENT", "ReceiptInfo": "SM6656c19132f1465f9c9c1123a5dde7c9", "ReceiptTime": "2021-05-18T20:40:52.962000+00:00" } ] }

詳細については、「 Incident Manager ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスListPageReceipts」の「」を参照してください。

次のコード例は、list-pages-by-contact を使用する方法を示しています。

AWS CLI

連絡先別にページを一覧表示するには

次のlist-pages-by-contact例では、指定された連絡先へのすべてのページを一覧表示します。

aws ssm-contacts list-pages-by-contact \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"

出力:

{ "Pages": [ { "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Sender": "cli", "SentTime": "2021-05-18T18:43:29.301000+00:00", "DeliveryTime": "2021-05-18T18:43:55.265000+00:00", "ReadTime": "2021-05-18T18:43:55.708000+00:00" } ] }

詳細については、「 Incident Manager ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスListPagesByContact」の「」を参照してください。

次のコード例は、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 ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスListPagesByEngagement」の「」を参照してください。

次のコード例は、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 ユーザーガイド」の「タグ付け」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスListTagsForResource」の「」を参照してください。

次の例は、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 ユーザーガイド」の「共有連絡先と対応計画の操作」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスPutContactPolicy」の「」を参照してください。

次のコード例は、send-activation-code を使用する方法を示しています。

AWS CLI

アクティベーションコードを送信するには

次のsend-activation-code例は、指定された問い合わせチャネルにアクティベーションコードとメッセージを送信します。

aws ssm-contacts send-activation-code \ --contact-channel-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/8ddae2d1-12c8-4e45-b852-c8587266c400"

このコマンドでは何も出力されません。

詳細については、「 Incident Manager ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスSendActivationCode」の「」を参照してください。

次のコード例は、start-engagement を使用する方法を示しています。

AWS CLI

例 1: 問い合わせの問い合わせチャネルをページングするには

次のstart-engagementページでは、 連絡先の問い合わせチャネルについて説明します。送信者、サブジェクト、パブリックサブジェクト、パブリックコンテンツにはすべてフィールドがありません。Incident Manager は、提供されたチャネルVOICEまたはEMAIL問い合わせチャネルに件名とコンテンツを送信します。Incident Manager は、提供されたSMS問い合わせチャネルにパブリックサブジェクトとパブリックコンテンツを送信します。送信者は、エンゲージメントを開始したユーザーを追跡するために使用されます。

aws ssm-contacts start-engagement \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" \ --sender "cli" \ --subject "cli-test" \ --content "Testing engagements via CLI" \ --public-subject "cli-test" \ --public-content "Testing engagements va CLI"

出力:

{ "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f" }

詳細については、「 Incident Manager ユーザーガイド」の「問い合わせ」を参照してください。

例 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 ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスStartEngagement」の「」を参照してください。

次の例は、stop-engagement を使用する方法を説明しています。

AWS CLI

エンゲージメントを停止するには

次のstop-engagement例では、エンゲージメントが追加の問い合わせと問い合わせチャネルをページングするのを停止します。

aws ssm-contacts stop-engagement \ --engagement-id "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"

このコマンドでは何も出力されません。

詳細については、「 Incident Manager ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスStopEngagement」の「」を参照してください。

次の例は、tag-resource を使用する方法を説明しています。

AWS CLI

連絡先にタグを付けるには

次のtag-resource例では、指定された連絡先に指定されたタグキー値ペアをタグ付けします。

aws ssm-contacts tag-resource \ --resource-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \ --tags '[{"Key":"group1","Value":"1"}]'

このコマンドでは何も出力されません。

詳細については、「 Incident Manager ユーザーガイド」の「タグ付け」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスTagResource」の「」を参照してください。

次のコード例は、untag-resource を使用する方法を示しています。

AWS CLI

連絡先からタグを削除するには

次のuntag-resource例では、指定された問い合わせから group1 タグを削除します。

aws ssm-contacts untag-resource \ --resource-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \ --tag-keys "group1"

このコマンドでは何も出力されません。

詳細については、「 Incident Manager ユーザーガイド」の「タグ付け」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスUntagResource」の「」を参照してください。

次の例は、update-contact-channel を使用する方法を説明しています。

AWS CLI

問い合わせチャネルを更新するには

次のupdate-contact-channel例では、問い合わせチャネルの名前と配信アドレスを更新します。

aws ssm-contacts update-contact-channel \ --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad" \ --name "akuas voice channel" \ --delivery-address '{"SimpleAddress": "+15005550198"}'

このコマンドでは何も出力されません。

詳細については、「 Incident Manager ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスUpdateContactChannel」の「」を参照してください。

次のコード例は、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 ユーザーガイド」の「問い合わせ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスUpdateContact」の「」を参照してください。