Working with chat channels in Incident Manager - Incident Manager

Working with chat channels in Incident Manager

Incident Manager, a capability of AWS Systems Manager, gives incident responders the ability to communicate directly through chat channels during an incident. A chat channel is a chat room that you set up in AWS Chatbot. You then connect this channel to a response plan in Incident Manager.

During an incident, responders use the chat channel to communicate with one another about the incident. Incident Manager also pushes any updates and notifications about the incident directly to the chat channel. It sends these notifications using one or more Amazon Simple Notification Service (Amazon SNS) topics that you specify in your chat room configuration.

AWS Chatbot and Incident Manager support chat channels in the following applications:

  • Slack

  • Microsoft Teams

  • Amazon Chime

The process for setting up a chat channel for use in your incidents consists of tasks in three different Amazon Web Services services.

Task 1: Create or update Amazon SNS topics for your chat channel

Amazon SNS is a managed service that provides message delivery from publishers to subscribers (also known as producers and consumers). Publishers communicate asynchronously with subscribers by sending messages to a topic, which is a logical access point and communication channel. Incident Manager uses one or more topics that you associate with a response plan to send notifications about an incident to the incident responders.

In a response plan, you can include one or more Amazon SNS topics to incident notifications. As a best practice, you should create an SNS topic in each AWS Region you have added to your replication set.

Tip

For a more linear setup workflow, we recommend that you configure your Amazon SNS topics for use with Incident Manager first. Once configured, you can create the chat channel.

To create or update Amazon SNS topics for your chat channel
  1. Follow the steps in the Creating an Amazon SNS topic in the Amazon Simple Notification Service Developer Guide.

    Note

    After you create the topic, you edit it to update its access policy.

  2. Select the topic that you created, and note or copy the Amazon Resource Name (ARN) of the topic, in a format such as arn:aws:sns:us-east-2:111122223333:My_SNS_topic.

  3. Choose Edit, and then expand the Access policy section to configure additional access permissions beyond the defaults.

  4. Add the following statement to the policy's Statement array:

    { "Sid": "IncidentManagerSNSPublishingPermissions", "Effect": "Allow", "Principal": { "Service": "ssm-incidents.amazonaws.com" }, "Action": "SNS:Publish", "Resource": "sns-topic-arn", "Condition": { "StringEqualsIfExists": { "AWS:SourceAccount": "account-id" } } }

    Replace the placeholder values as follows:

    • sns-topic-arn is the Amazon Resource Name (ARN) of the topic that you created for this Region, in the format arn:aws:sns:us-east-2:111122223333:My_SNS_topic.

    • account-id is the ID of the AWS account that you are working in, such as 111122223333.

  5. Choose Save changes.

  6. Repeat the process in each Region included in your replication set.

Task 2: Create a chat channel in AWS Chatbot

You can create a chat channel in Slack, Microsoft Teams, or Amazon Chime. You need only one chat channel for each response plan.

For your chat channels, we recommend following the principal of least privilege (not providing users with more permissions than needed to complete their tasks). You should also regularly review the membership of your AWS Chatbot chat channels. Reviews help check that only the appropriate responders and other stakeholders have access to your chat channels.

In AWS Chatbot enabled Slack channels and Microsoft Teams channels, incident responders can run a number of Incident Manager CLI commands directly from the Slack or Microsoft Teams application. For more information, see Interacting through the chat channel.

Important

The users you add to your chat channel must be the same contacts listed on your escalation or response plan. You can also add additional users to chat channels, such as stakeholders and incident observers.

For general information about AWS Chatbot, see What is AWS Chatbot in the AWS Chatbot Administrator Guide.

Choose from the following applications to create your channel in:

Slack

The steps in this procedure provide the recommended permission settings to allow all channel users to use chat commands with Incident Manager. Using supported chat commands, your incident responders can update and interact with the incident directly from the Slack chat channel. For information, see Interacting through the chat channel.

To create a chat channel in Slack
  • Follow the steps in Tutorial: Get started with Slack in the AWS Chatbot Administrator Guide and include the following in your configuration.

    • In step 10, for Role settings, choose Channel role.

    • In step 10d, for Policy templates, select Incident Manager permissions.

    • In step 11, for Channel guardrail policies, for Policy name, choose AWSIncidentManagerResolverAccess.

    • In step 12, in the SNS topics section, do the following:

      • For Region 1, select an AWS Region that is included in your replication set.

      • For Topics 1, select the SNS topic you created in that Region to use to send incident notifications to the chat channel.

      • For each additional Region in your replication set, choose Add another Region and add the additional Regions and SNS topics.

Microsoft Teams

The steps in this procedure provide the recommended permission settings to allow all channel users to use chat commands with Incident Manager. Using supported chat commands, your incident responders can update and interact with the incident directly from the Microsoft Teams chat channel. For information, see Interacting through the chat channel.

To create a chat channel in Microsoft Teams
  • Follow the steps in Tutorial: Get started with Microsoft Teams in the AWS Chatbot Administrator Guide and include the following in your configuration:

    • In step 10, for Role settings, choose Channel role.

    • In step 10d, for Policy templates, select Incident Manager permissions.

    • In step 11, for Channel guardrail policies, for Policy name, choose AWSIncidentManagerResolverAccess.

    • In step 12, in the SNS topics section, do the following:

      • For Region 1, select an AWS Region that is included in your replication set.

      • For Topics 1, select the SNS topic you created in that Region to use to send incident notifications to the chat channel.

      • For each additional Region in your replication set, choose Add another Region and add the additional Regions and SNS topics.

Amazon Chime
To create a chat channel in Amazon Chime
  • Follow the steps in Tutorial: Get started with Amazon Chime in the AWS Chatbot Administrator Guide and include the following in your configuration:

    • In step 11, for Policy templates, select Incident Manager permissions.

    • In step 12, in the SNS topics section, select the SNS topics that will send notifications to the Amazon Chime webhook:

      • For Region 1, select an AWS Region that is included in your replication set.

      • For Topics 1, select the SNS topic you created in that Region to use to send incident notifications to the chat channel.

      • For each additional Region in your replication set, choose Add another Region and add the additional Regions and SNS topics.

Note

Chat commands, which incident responders can use in Slack and Microsoft Teams chat channels, are not supported in Amazon Chime.

Task 3: Add the chat channel to a response plan in Incident Manager

When you create or update a response plan, you can add chat channels for responders to communicate and receive updates through.

When following the steps in Creating a response plan, for the section (Optional) Specifying an incident response chat channel, select the channel you want to use for incidents related to this response plan.

Interacting through the chat channel

For channels in Slack and Microsoft Teams, Incident Manager enables responders to interact with incidents directly from the chat channel using the following ssm-incidents commands:

To run commands in an active incident's chat channel, use the following format. Replace cli-options with any options to be included for a command.

@aws ssm-incidents cli-options

For example:

@aws ssm-incidents start-incident --response-plan-arn arn:aws:ssm-incidents::111122223333:response-plan/test-response-plan-chat --region us-east-2
@aws ssm-incidents create-timeline-event --event-data "\"example timeline event"\" --event-time 2023-03-31 T20:30:00.000 --event-type Custom Event --incident-record-arn arn:aws:ssm-incidents::111122223333:incident-record/MyResponsePlanChat/98c397e6-7c10-aa10-9b86-f199aEXAMPLE
@aws ssm-incidents list-incident-records