View a markdown version of this page

Onboard to Incident Detection and Response with the IDR CLI - AWS Incident Detection and Response User Guide

Onboard to Incident Detection and Response with the IDR CLI

The AWS Incident Detection and Response Customer Command Line Interface (IDR CLI) is a command line interface tool that streamlines onboarding to AWS Incident Detection and Response.

The IDR CLI runs in AWS CloudShell to perform the following functions:

  • Collect onboarding information

  • Gather AWS resource data through the Resource Groups Tagging API

  • Manage AWS Support cases

  • Create new Amazon CloudWatch alarms or ingest your existing ones

  • Deploy and test infrastructure through AWS CloudFormation to allow third-party tools to send alerts to Incident Detection and Response.

The IDR CLI can run in an interactive mode to guide you through the onboarding steps, or in offline mode for bulk or DevOps use cases.

For more information on how to use the IDR CLI, including installation, prerequisites, and end-to-end examples, see CLI for AWS Incident Detection and Response.

Language support for the IDR CLI

AWS Incident Detection and Response is available in English, Japanese, Mandarin, and Korean. If you need support in Japanese, Mandarin, or Korean, contact AWS through the AWS Support case created by the IDR CLI, or contact your Technical Account Manager (TAM).

Alternative options for onboarding workloads

If you can't use the IDR CLI for onboarding, consult your Technical Account Manager (TAM) for alternative options. For more information, see Workload onboarding and alarm ingestion questionnaires in Incident Detection and Response (exception path)