を使用した Incident Manager の例 AWS CLI - AWS SDK コード例

Doc AWS SDK Examples リポジトリには、他にも SDK の例があります。 AWS GitHub

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

を使用した Incident Manager の例 AWS CLI

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

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

「シナリオ」は、同じサービス内で複数の関数を呼び出して、特定のタスクを実行する方法を示すコード例です。

各例には、 へのリンクが含まれています。このリンクには GitHub、コンテキスト内でコードをセットアップして実行する方法の手順が記載されています。

トピック

アクション

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

AWS CLI

レプリケーションセットを作成するには

次のcreate-replication-set例では、Incident Manager が Amazon Web Services アカウントのデータをレプリケートおよび暗号化するために使用するレプリケーションセットを作成します。この例では、レプリケーションセットの作成時に us-east-1 リージョンと us-east-2 リージョンを使用します。

aws ssm-incidents create-replication-set \ --regions '{"us-east-1": {"sseKmsKeyId": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"}, "us-east-2": {"sseKmsKeyId": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"}}'

出力:

{ "replicationSetArns": [ "arn:aws:ssm-incidents::111122223333:replication-set/c4bcb603-4bf9-bb3f-413c-08df53673b57" ] }

詳細については、Incident Manager ユーザーガイドの「Incident Manager レプリケーションセットの使用」を参照してください。

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

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

AWS CLI

対応計画を作成するには

次のcreate-response-plan例では、指定された詳細で対応計画を作成します。

aws ssm-incidents create-response-plan \ --chat-channel '{"chatbotSns": ["arn:aws:sns:us-east-1:111122223333:Standard_User"]}' \ --display-name "Example response plan" \ --incident-template '{"impact": 5, "title": "example-incident"}' \ --name "example-response" \ --actions '[{"ssmAutomation": {"documentName": "AWSIncidents-CriticalIncidentRunbookTemplate", "documentVersion": "$DEFAULT", "roleArn": "arn:aws:iam::111122223333:role/aws-service-role/ssm-incidents.amazonaws.com/AWSServiceRoleForIncidentManager", "targetAccount": "RESPONSE_PLAN_OWNER_ACCOUNT"}}]' \ --engagements '["arn:aws:ssm-contacts:us-east-1:111122223333:contact/example"]'

出力:

{ "arn": "arn:aws:ssm-incidents::111122223333:response-plan/example-response" }

詳細については、Incident Manager ユーザーガイドの「インシデントの準備」を参照してください。

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

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

AWS CLI

例 1: カスタムタイムラインイベントを作成するには

次のcreate-timeline-event例では、指定されたインシデントの指定された時刻にカスタムタイムラインイベントを作成します。

aws ssm-incidents create-timeline-event \ --event-data "\"example timeline event\"" \ --event-time 2022-10-01T20:30:00.000 \ --event-type "Custom Event" \ --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4EXAMPLE"

出力:

{ "eventId": "c0bcc885-a41d-eb01-b4ab-9d2deEXAMPLE", "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4EXAMPLE" }

例 2: インシデントメモを含むタイムラインイベントを作成するには

次のcreate-timeline-event例では、「インシデントメモ」パネルにリストされているタイムラインイベントを作成します。

aws ssm-incidents create-timeline-event \ --event-data "\"New Note\"" \ --event-type "Note" \ --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Test/6cc46130-ca6c-3b38-68f1-f6abeEXAMPLE" \ --event-time 2023-06-20T12:06:00.000 \ --event-references '[{"resource":"arn:aws:ssm-incidents::111122223333:incident-record/Test/6cc46130-ca6c-3b38-68f1-f6abeEXAMPLE"}]'

出力:

{ "eventId": "a41dc885-c0bc-b4ab-eb01-de9d2EXAMPLE", "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4EXAMPLE" }

詳細については、Incident Manager ユーザーガイドの「インシデントの詳細」を参照してください。

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

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

AWS CLI

インシデントレコードを削除するには

次のdelete-incident-record例では、指定されたインシデントレコードを削除します。

aws ssm-incidents delete-incident-record \ --arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308"

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

詳細については、Incident Manager ユーザーガイドの「インシデント追跡」を参照してください。

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

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

AWS CLI

レプリケーションセットを削除するには

次のdelete-replication-set例では、Amazon Web Services アカウントからレプリケーションセットを削除します。レプリケーションセットを削除すると、Incident Manager データもすべて削除されます。これは元に戻すことはできません。

aws ssm-incidents delete-replication-set \ --arn "arn:aws:ssm-incidents::111122223333:replication-set/c4bcb603-4bf9-bb3f-413c-08df53673b57"

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

詳細については、Incident Manager ユーザーガイドの「Incident Manager レプリケーションセットの使用」を参照してください。

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

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

AWS CLI

リソースポリシーを削除するには

次のdelete-resource-policy例では、対応計画からリソースポリシーを削除します。これにより、対応計画が共有されたプリンシパルまたは組織からのアクセスが取り消されます。

aws ssm-incidents delete-resource-policy \ --policy-id "be8b57191f0371f1c6827341aa3f0a03" \ --resource-arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan"

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

詳細については、Incident Manager ユーザーガイドの「共有連絡先と対応計画の使用」を参照してください。

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

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

AWS CLI

対応計画を削除するには

次のdelete-response-plan例では、指定された対応計画を削除します。

aws ssm-incidents delete-response-plan \ --arn "arn:aws:ssm-incidents::111122223333:response-plan/example-response"

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

詳細については、Incident Manager ユーザーガイドの「インシデントの準備」を参照してください。

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

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

AWS CLI

タイムラインイベントを削除するには

次のdelete-timeline-event例では、指定されたインシデントレコードからカスタムタイムラインイベントを削除します。

aws ssm-incidents delete-timeline-event \ --event-id "c0bcc885-a41d-eb01-b4ab-9d2de193643c" \ --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308"

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

詳細については、Incident Manager ユーザーガイドの「インシデントの詳細」を参照してください。

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

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

AWS CLI

インシデントレコードを取得するには

次のget-incident-record例では、指定されたインシデントレコードの詳細を取得します。

aws ssm-incidents get-incident-record \ --arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308"

出力:

{ "incidentRecord": { "arn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308", "automationExecutions": [], "creationTime": "2021-05-21T18:16:57.579000+00:00", "dedupeString": "c4bcc812-85e7-938d-2b78-17181176ee1a", "impact": 5, "incidentRecordSource": { "createdBy": "arn:aws:iam::111122223333:user/draliatp", "invokedBy": "arn:aws:iam::111122223333:user/draliatp", "source": "aws.ssm-incidents.custom" }, "lastModifiedBy": "arn:aws:iam::111122223333:user/draliatp", "lastModifiedTime": "2021-05-21T18:16:59.149000+00:00", "notificationTargets": [], "status": "OPEN", "title": "Example-Incident" } }

詳細については、Incident Manager ユーザーガイドの「インシデントの詳細」を参照してください。

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

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

AWS CLI

レプリケーションセットを取得するには

次のget-replication-set例では、Incident Manager が Amazon Web Services アカウントのデータをレプリケートおよび暗号化するために使用するレプリケーションセットの詳細を取得します。

aws ssm-incidents get-replication-set \ --arn "arn:aws:ssm-incidents::111122223333:replication-set/c4bcb603-4bf9-bb3f-413c-08df53673b57"

出力:

{ "replicationSet": { "createdBy": "arn:aws:sts::111122223333:assumed-role/Admin/username", "createdTime": "2021-05-14T17:57:22.010000+00:00", "deletionProtected": false, "lastModifiedBy": "arn:aws:sts::111122223333:assumed-role/Admin/username", "lastModifiedTime": "2021-05-14T17:57:22.010000+00:00", "regionMap": { "us-east-1": { "sseKmsKeyId": "DefaultKey", "status": "ACTIVE" }, "us-east-2": { "sseKmsKeyId": "DefaultKey", "status": "ACTIVE", "statusMessage": "Tagging inaccessible" } }, "status": "ACTIVE" } }

詳細については、Incident Manager ユーザーガイドの「Incident Manager レプリケーションセットの使用」を参照してください。

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

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

AWS CLI

対応計画のリソースポリシーを一覧表示するには

次のcommand-name例では、指定された対応計画に関連付けられているリソースポリシーを一覧表示します。

aws ssm-incidents get-resource-policies \ --resource-arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan"

出力:

{ "resourcePolicies": [ { "policyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"d901b37a-dbb0-458a-8842-75575c464219-external-principals\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::222233334444:root\"},\"Action\":[\"ssm-incidents:GetResponsePlan\",\"ssm-incidents:StartIncident\",\"ssm-incidents:UpdateIncidentRecord\",\"ssm-incidents:GetIncidentRecord\",\"ssm-incidents:CreateTimelineEvent\",\"ssm-incidents:UpdateTimelineEvent\",\"ssm-incidents:GetTimelineEvent\",\"ssm-incidents:ListTimelineEvents\",\"ssm-incidents:UpdateRelatedItems\",\"ssm-incidents:ListRelatedItems\"],\"Resource\":[\"arn:aws:ssm-incidents:*:111122223333:response-plan/Example-Response-Plan\",\"arn:aws:ssm-incidents:*:111122223333:incident-record/Example-Response-Plan/*\"]}]}", "policyId": "be8b57191f0371f1c6827341aa3f0a03", "ramResourceShareRegion": "us-east-1" } ] }

詳細については、Incident Manager ユーザーガイドの「共有連絡先と対応計画の使用」を参照してください。

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

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

AWS CLI

対応計画の詳細を取得するには

次のcommand-name例では、 AWS アカウント内の指定された対応計画に関する詳細を取得します。

aws ssm-incidents get-response-plan \ --arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan"

出力:

{ "actions": [ { "ssmAutomation": { "documentName": "AWSIncidents-CriticalIncidentRunbookTemplate", "documentVersion": "$DEFAULT", "roleArn": "arn:aws:iam::111122223333:role/aws-service-role/ssm-incidents.amazonaws.com/AWSServiceRoleForIncidentManager", "targetAccount": "RESPONSE_PLAN_OWNER_ACCOUNT" } } ], "arn": "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan", "chatChannel": { "chatbotSns": [ "arn:aws:sns:us-east-1:111122223333:Standard_User" ] }, "displayName": "Example response plan", "engagements": [ "arn:aws:ssm-contacts:us-east-1:111122223333:contact/example" ], "incidentTemplate": { "impact": 5, "title": "Example-Incident" }, "name": "Example-Response-Plan" }

詳細については、Incident Manager ユーザーガイドの「インシデントの準備」を参照してください。

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

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

AWS CLI

タイムラインイベントの詳細を取得するには

次のget-timeline-event例では、指定されたタイムラインイベントの詳細を返します。

aws ssm-incidents get-timeline-event \ --event-id 20bcc812-8a94-4cd7-520c-0ff742111424 \ --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308"

出力:

{ "event": { "eventData": "\"Incident Started\"", "eventId": "20bcc812-8a94-4cd7-520c-0ff742111424", "eventTime": "2021-05-21T18:16:57+00:00", "eventType": "Custom Event", "eventUpdatedTime": "2021-05-21T18:16:59.944000+00:00", "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" } }

詳細については、Incident Manager ユーザーガイドの「インシデントの詳細」を参照してください。

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

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

AWS CLI

インシデントレコードを一覧表示するには

次のcommand-name例では、Amazon Web Services アカウントのインシデントレコードを一覧表示します。

aws ssm-incidents list-incident-records

出力:

{ "incidentRecordSummaries": [ { "arn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308", "creationTime": "2021-05-21T18:16:57.579000+00:00", "impact": 5, "incidentRecordSource": { "createdBy": "arn:aws:iam::111122223333:user/draliatp", "invokedBy": "arn:aws:iam::111122223333:user/draliatp", "source": "aws.ssm-incidents.custom" }, "status": "OPEN", "title": "Example-Incident" } ] }

詳細については、Incident Manager ユーザーガイドの「インシデントリスト」を参照してください。

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

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

AWS CLI

関連項目を一覧表示するには

次のlist-related-items例では、指定されたインシデントの関連項目を一覧表示します。

aws ssm-incidents list-related-items \ --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308"

出力:

{ "relatedItems": [ { "identifier": { "type": "OTHER", "value": { "url": "https://console.aws.amazon.com/systems-manager/opsitems/oi-8ef82158e190/workbench?region=us-east-1" } }, "title": "Example related item" }, { "identifier": { "type": "PARENT", "value": { "arn": "arn:aws:ssm:us-east-1:111122223333:opsitem/oi-8084126392ac" } }, "title": "parentItem" } ] }

詳細については、Incident Manager ユーザーガイドの「インシデントの詳細」を参照してください。

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

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

AWS CLI

レプリケーションセットを一覧表示するには

次のlist-replication-set例では、Incident Manager が AWS アカウントのデータをレプリケートおよび暗号化するために使用するレプリケーションセットを一覧表示します。

aws ssm-incidents list-replication-sets

出力:

{ "replicationSetArns": [ "arn:aws:ssm-incidents::111122223333:replication-set/c4bcb603-4bf9-bb3f-413c-08df53673b57" ] }

詳細については、Incident Manager ユーザーガイドの「Incident Manager レプリケーションセットの使用」を参照してください。

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

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

AWS CLI

利用可能な対応計画を一覧表示するには

次のlist-response-plans例では、Amazon Web Services アカウントで使用可能な対応計画を一覧表示します。

aws ssm-incidents list-response-plans

出力:

{ "responsePlanSummaries": [ { "arn": "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan", "displayName": "Example response plan", "name": "Example-Response-Plan" } ] }

詳細については、Incident Manager ユーザーガイドの「インシデントの準備」を参照してください。

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

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

AWS CLI

対応計画のタグを一覧表示するには

次のlist-tags-for-resource例では、指定された対応計画に関連付けられたタグを一覧表示します。

aws ssm-incidents list-tags-for-resource \ --resource-arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan"

出力:

{ "tags": { "group1": "1" } }

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

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

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

AWS CLI

インシデントのタイムラインイベントを一覧表示するには

次のcommand-name例では、指定されたインシデントのタイムラインイベントを一覧表示します。

aws ssm-incidents list-timeline-events \ --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308"

出力:

{ "eventSummaries": [ { "eventId": "8cbcc889-35e1-a42d-2429-d6f100799915", "eventTime": "2021-05-21T22:36:13.766000+00:00", "eventType": "SSM Incident Record Update", "eventUpdatedTime": "2021-05-21T22:36:13.766000+00:00", "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" }, { "eventId": "a2bcc825-aab5-1787-c605-f9bb2640d85b", "eventTime": "2021-05-21T18:58:46.443000+00:00", "eventType": "SSM Incident Record Update", "eventUpdatedTime": "2021-05-21T18:58:46.443000+00:00", "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" }, { "eventId": "5abcc812-89c0-b0a8-9437-1c74223d4685", "eventTime": "2021-05-21T18:16:59.149000+00:00", "eventType": "SSM Incident Record Update", "eventUpdatedTime": "2021-05-21T18:16:59.149000+00:00", "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" }, { "eventId": "06bcc812-8820-405e-4065-8d2b14d29b92", "eventTime": "2021-05-21T18:16:58+00:00", "eventType": "SSM Automation Execution Start Failure for Incident", "eventUpdatedTime": "2021-05-21T18:16:58.689000+00:00", "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" }, { "eventId": "20bcc812-8a94-4cd7-520c-0ff742111424", "eventTime": "2021-05-21T18:16:57+00:00", "eventType": "Custom Event", "eventUpdatedTime": "2021-05-21T18:16:59.944000+00:00", "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" }, { "eventId": "c0bcc885-a41d-eb01-b4ab-9d2de193643c", "eventTime": "2020-10-01T20:30:00+00:00", "eventType": "Custom Event", "eventUpdatedTime": "2021-05-21T22:28:26.299000+00:00", "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" } ] }

詳細については、Incident Manager ユーザーガイドの「インシデントの詳細」を参照してください。

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

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

AWS CLI

対応計画とインシデントを共有するには

次のcommand-name例では、指定されたプリンシパルと対応計画と関連するインシデントを共有するリソースポリシーを Example-Response-Plan に追加します。

aws ssm-incidents put-resource-policy \ --resource-arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" \ --policy "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"ExampleResourcePolciy\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::222233334444:root\"},\"Action\":[\"ssm-incidents:GetResponsePlan\",\"ssm-incidents:StartIncident\",\"ssm-incidents:UpdateIncidentRecord\",\"ssm-incidents:GetIncidentRecord\",\"ssm-incidents:CreateTimelineEvent\",\"ssm-incidents:UpdateTimelineEvent\",\"ssm-incidents:GetTimelineEvent\",\"ssm-incidents:ListTimelineEvents\",\"ssm-incidents:UpdateRelatedItems\",\"ssm-incidents:ListRelatedItems\"],\"Resource\":[\"arn:aws:ssm-incidents:*:111122223333:response-plan/Example-Response-Plan\",\"arn:aws:ssm-incidents:*:111122223333:incident-record/Example-Response-Plan/*\"]}]}"

出力:

{ "policyId": "be8b57191f0371f1c6827341aa3f0a03" }

詳細については、Incident Manager ユーザーガイドの「共有連絡先と対応計画の使用」を参照してください。

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

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

AWS CLI

インシデントを開始するには

次のstart-incident例では、指定された対応計画を使用してインシデントを開始します。

aws ssm-incidents start-incident \ --response-plan-arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan"

出力:

{ "incidentRecordArn": "arn:aws:ssm-incidents::682428703967:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" }

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

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

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

AWS CLI

対応計画にタグを付けるには

次のtag-resource例では、指定されたタグキーと値のペアを使用して、指定された対応計画にタグを付けます。

aws ssm-incidents tag-resource \ --resource-arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" \ --tags '{"group1":"1"}'

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

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

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

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

AWS CLI

対応計画からタグを削除するには

次のuntag-resource例では、指定されたタグを対応計画から削除します。

aws ssm-incidents untag-resource \ --resource-arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" \ --tag-keys '["group1"]'

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

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

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

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

AWS CLI

レプリケーションセットの削除保護を更新するには

次のupdate-deletion-protection例では、アカウントの削除保護を更新して、レプリケーションセットの最後のリージョンを削除しないようにします。

aws ssm-incidents update-deletion-protection \ --arn "arn:aws:ssm-incidents::111122223333:replication-set/a2bcc5c9-0f53-8047-7fef-c20749989b40" \ --deletion-protected

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

詳細については、Incident Manager ユーザーガイドの「Incident Manager レプリケーションセットの使用」を参照してください。

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

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

AWS CLI

インシデントレコードを更新するには

次のcommand-name例では、指定されたインシデントを解決します。

aws ssm-incidents update-incident-record \ --arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" \ --status "RESOLVED"

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

詳細については、Incident Manager ユーザーガイドの「インシデントの詳細」を参照してください。

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

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

AWS CLI

インシデント関連項目を更新するには

次のupdate-related-item例では、指定されたインシデントレコードから関連項目を削除します。

aws ssm-incidents update-related-items \ --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" \ --related-items-update '{"itemToRemove": {"type": "OTHER", "value": {"url": "https://console.aws.amazon.com/systems-manager/opsitems/oi-8ef82158e190/workbench?region=us-east-1"}}}'

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

詳細については、Incident Manager ユーザーガイドの「インシデントの詳細」を参照してください。

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

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

AWS CLI

レプリケーションセットを更新するには

次のcommand-name例では、us-east-2 リージョンをレプリケーションセットから削除します。

aws ssm-incidents update-replication-set \ --arn "arn:aws:ssm-incidents::111122223333:replication-set/a2bcc5c9-0f53-8047-7fef-c20749989b40" \ --actions '[{"deleteRegionAction": {"regionName": "us-east-2"}}]'

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

詳細については、Incident Manager ユーザーガイドの「Incident Manager レプリケーションセットの使用」を参照してください。

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

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

AWS CLI

対応計画を更新するには

次のupdate-response-plan例では、指定された対応計画からチャットチャネルを削除します。

aws ssm-incidents update-response-plan \ --arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" \ --chat-channel '{"empty":{}}'

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

詳細については、Incident Manager ユーザーガイドの「インシデントの準備」を参照してください。

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

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

AWS CLI

タイムラインイベントを更新するには

次のupdate-timeline-event例では、イベントが発生した時刻を更新します。

aws ssm-incidents update-timeline-event \ --event-id 20bcc812-8a94-4cd7-520c-0ff742111424 \ --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" \ --event-time "2021-05-21T18:10:57+00:00"

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

詳細については、Incident Manager ユーザーガイドの「インシデントの詳細」を参照してください。

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