Beispiele zur Verwendung von Incident Manager mit AWS CLI - AWS Command Line Interface
Aktionen

Beispiele zur Verwendung von Incident Manager mit AWS CLI

Die folgenden Codebeispiele zeigen, wie Sie Aktionen durchführen und gängige Szenarien implementieren, indem Sie die AWS Command Line Interface mit Incident Manager nutzen.

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Service-Funktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarien anzeigen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, wo Sie Anleitungen zum Einrichten und Ausführen des Codes im Kontext finden.

Themen

Aktionen

Das folgende Codebeispiel zeigt, wie create-replication-set verwendet wird.

AWS CLI

So erstellen Sie den Replikationssatz

Im folgenden Beispiel für create-replication-set wird der Replikationssatz erstellt, den Incident Manager verwendet, um Daten in Ihrem Amazon Web Services-Konto zu replizieren und zu verschlüsseln. In diesem Beispiel werden die Regionen us-east-1 und us-east-2 bei der Erstellung des Replikationssatzes verwendet.

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"}}'

Ausgabe:

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

Weitere Informationen finden Sie unter Verwenden des Replikationssatzes in Incident Manager im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie create-response-plan verwendet wird.

AWS CLI

So erstellen Sie einen Reaktionsplan

Im folgenden Beispiel für create-response-plan wird ein Reaktionsplan mit den angegebenen Details erstellt.

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"]'

Ausgabe:

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

Weitere Informationen finden Sie unter Vorfallvorbereitung im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie create-timeline-event verwendet wird.

AWS CLI

Beispiel 1: So erstellen Sie ein benutzerdefiniertes Zeitleistenereignis

Im folgenden Beispiel für create-timeline-event wird ein benutzerdefiniertes Zeitleistenereignis zur angegebenen Zeit für den angegebenen Vorfall erstellt.

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"

Ausgabe:

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

Beispiel 2: So erstellen Sie ein Zeitleistenereignis mit einer Vorfallnotiz

Im folgenden Beispiel für create-timeline-event wird ein Zeitleistenereignis erstellt, das im Bereich „Vorfallnotizen“ aufgeführt ist.

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"}]'

Ausgabe:

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

Weitere Informationen finden Sie unter Vorfalldetails im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie delete-incident-record verwendet wird.

AWS CLI

So löschen Sie einen Vorfalldatensatz

Im folgenden Beispiel für delete-incident-record wird der angegebene Vorfallbericht gelöscht.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Vorfallverfolgung im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie delete-replication-set verwendet wird.

AWS CLI

So löschen Sie den Replikationssatz

Im folgenden Beispiel für delete-replication-set wird der Replikationssatz aus Ihrem Amazon Web Services-Konto gelöscht. Durch Löschen des Replikationssatzes werden auch alle Incident Manager-Daten gelöscht. Dieser Vorgang kann nicht rückgängig gemacht werden.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Verwenden des Replikationssatzes in Incident Manager im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie delete-resource-policy verwendet wird.

AWS CLI

So löschen Sie eine Ressourcenrichtlinie

Im folgenden Beispiel für delete-resource-policy wird eine Ressourcenrichtlinie aus einem Reaktionsplan gelöscht. Dies entzieht dem Prinzipal oder der Organisation, mit dem oder der der Reaktionsplan geteilt wurde, den Zugriff.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Arbeiten mit freigegebenen Kontakten und Reaktionsplänen im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie delete-response-plan verwendet wird.

AWS CLI

So löschen Sie einen Reaktionsplan

Im folgenden Beispiel für delete-response-plan wird der angegebene Reaktionsplan gelöscht.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Vorfallvorbereitung im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie delete-timeline-event verwendet wird.

AWS CLI

So löschen Sie ein Zeitleistenereignis

Im folgenden Beispiel für delete-timeline-event wird ein benutzerdefiniertes Zeitleistenereignis aus dem angegebenen Vorfalldatensatz gelöscht.

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"

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Vorfalldetails im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie get-incident-record verwendet wird.

AWS CLI

So rufen Sie einen Vorfalldatensatz ab

Im folgenden Beispiel für get-incident-record werden Details zu dem angegebenen Vorfalldatensatz abgerufen.

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

Ausgabe:

{
    "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"
    }
}

Weitere Informationen finden Sie unter Vorfalldetails im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie get-replication-set verwendet wird.

AWS CLI

So rufen Sie den Replikationssatz ab

Im folgenden Beispiel für get-replication-set wird der Replikationssatz abgerufen, den Incident Manager verwendet, um Daten in Ihrem Amazon Web Services-Konto zu replizieren und zu verschlüsseln.

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

Ausgabe:

{
    "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"
    }
}

Weitere Informationen finden Sie unter Verwenden des Replikationssatzes in Incident Manager im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie get-resource-policies verwendet wird.

AWS CLI

So listen Sie Ressourcenrichtlinien für einen Reaktionsplan auf

Im folgenden Beispiel für command-name werden die Ressourcenrichtlinien aufgelistet, die dem angegebenen Reaktionsplan zugeordnet sind.

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

Ausgabe:

{
    "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"
        }
    ]
}

Weitere Informationen finden Sie unter Arbeiten mit freigegebenen Kontakten und Reaktionsplänen im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie get-response-plan verwendet wird.

AWS CLI

So rufen Sie Details zu einem Reaktionsplan ab

Im folgenden Beispiel für command-name werden Details zu einem bestimmten Reaktionsplan in Ihrem AWS-Konto abgerufen.

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

Ausgabe:

{
    "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"
}

Weitere Informationen finden Sie unter Vorfallvorbereitung im Benutzerhandbuch zu Incident Manager.

  • API-Details finden Sie unter GetResponsePlan in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-timeline-event verwendet wird.

AWS CLI

So rufen Sie Details zu einem Zeitlinienereignis ab

Im folgenden Beispiel für get-timeline-event werden Details zum angegebenen Zeitlinienereignis zurückgegeben.

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"

Ausgabe:

{
    "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"
    }
}

Weitere Informationen finden Sie unter Vorfalldetails im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie list-incident-records verwendet wird.

AWS CLI

So listen Sie Vorfalldatensätze auf

Im folgenden Beispiel für command-name werden die Vorfalldatensätze in Ihrem Amazon Web Services-Konto aufgelistet.

aws ssm-incidents list-incident-records

Ausgabe:

{
    "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"
        }
    ]
}

Weitere Informationen finden Sie unter Vorfallliste im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie list-related-items verwendet wird.

AWS CLI

So listen Sie verwandte Elemente auf

Im folgenden Beispiel für list-related-items werden die verwandten Elemente des angegebenen Vorfalls aufgelistet.

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

Ausgabe:

{
    "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"
        }
    ]
}

Weitere Informationen finden Sie unter Vorfalldetails im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie list-replication-sets verwendet wird.

AWS CLI

So listen Sie den Replikationssatz auf

Im folgenden Beispiel für list-replication-set wird der Replikationssatz erstellt, den Incident Manager verwendet, um Daten in Ihrem Amazon Web Services-Konto zu replizieren und zu verschlüsseln.

aws ssm-incidents list-replication-sets

Ausgabe:

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

Weitere Informationen finden Sie unter Verwenden des Replikationssatzes in Incident Manager im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie list-response-plans verwendet wird.

AWS CLI

So listen Sie die verfügbaren Reaktionspläne auf

Im folgenden Beispiel für list-response-plans werden die verfügbaren Reaktionspläne in Ihrem Amazon Web Services-Konto aufgelistet.

aws ssm-incidents list-response-plans

Ausgabe:

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

Weitere Informationen finden Sie unter Vorfallvorbereitung im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie list-tags-for-resource verwendet wird.

AWS CLI

So listen Sie Tags für einen Reaktionsplan auf

Im folgenden Beispiel für list-tags-for-resource werden die Tags aufgelistet, die dem angegebenen Reaktionsplan zugeordnet sind.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Markieren im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie list-timeline-events verwendet wird.

AWS CLI

So listen Sie die Zeitlinienereignisse eines Vorfalls auf

Im folgenden Beispiel für command-name werden die Zeitlinienereignisse des angegebenen Vorfalls aufgelistet.

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

Ausgabe:

{
    "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"
        }
    ]
}

Weitere Informationen finden Sie unter Vorfalldetails im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie put-resource-policy verwendet wird.

AWS CLI

So teilen Sie einen Reaktionsplan und Vorfälle

Im folgenden Beispiel für command-name wird dem Beispiel-Reaktionsplan eine Ressourcenrichtlinie hinzugefügt, die den Reaktionsplan und die zugehörigen Vorfälle mit dem angegebenen Prinzipal teilt.

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/*\"]}]}"

Ausgabe:

{
    "policyId": "be8b57191f0371f1c6827341aa3f0a03"
}

Weitere Informationen finden Sie unter Arbeiten mit freigegebenen Kontakten und Reaktionsplänen im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie start-incident verwendet wird.

AWS CLI

So starten Sie einen Vorfall

Im folgenden Beispiel für start-incident wird ein Vorfall mit dem angegebenen Reaktionsplan gestartet.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Vorfallerstellung im Benutzerhandbuch zu Incident Manager.

  • API-Details finden Sie unter StartIncident in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie tag-resource verwendet wird.

AWS CLI

So markieren Sie einen Reaktionsplan

Im folgenden Beispiel für tag-resource wird ein angegebener Reaktionsplan mit dem angegebenen Tag-Schlüssel-Wert-Paar markiert.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Markieren im Benutzerhandbuch zu Incident Manager.

  • API-Details finden Sie unter TagResource in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie untag-resource verwendet wird.

AWS CLI

So entfernen Sie Tags von einem Reaktionsplan

Im folgenden Beispiel für untag-resource werden die angegebenen Tags aus dem Reaktionsplan entfernt.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Markieren im Benutzerhandbuch zu Incident Manager.

  • API-Details finden Sie unter UntagResource in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie update-deletion-protection verwendet wird.

AWS CLI

So aktualisieren Sie den Löschschutz für den Replikationssatz

Im folgenden Beispiel für update-deletion-protection wird der Löschschutz in Ihrem Konto aktualisiert, um zu verhindern, dass Sie versehentlich die letzte Region in Ihrem Replikationssatz löschen.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Verwenden des Replikationssatzes in Incident Manager im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie update-incident-record verwendet wird.

AWS CLI

So aktualisieren Sie einen Vorfalldatensatz

Im folgenden Beispiel für command-name wird der angegebene Vorfall gelöst.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Vorfalldetails im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie update-related-items verwendet wird.

AWS CLI

So aktualisieren Sie ein Vorfall-verwandtes Element

Im folgenden Beispiel für update-related-item wird ein verwandtes Element aus dem angegebenen Vorfalldatensatz entfernt.

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"}}}'

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Vorfalldetails im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie update-replication-set verwendet wird.

AWS CLI

So aktualisieren Sie einen Replikationssatz

Im folgenden Beispiel für command-name wird die Region us-east-2 aus dem Replikationssatz gelöscht.

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"}}]'

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Verwenden des Replikationssatzes in Incident Manager im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie update-response-plan verwendet wird.

AWS CLI

So aktualisieren Sie einen Reaktionsplan

Im folgenden Beispiel für update-response-plan wird ein Chatkanal aus dem angegebenen Reaktionsplan entfernt.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Vorfallvorbereitung im Benutzerhandbuch zu Incident Manager.

Das folgende Codebeispiel zeigt, wie update-timeline-event verwendet wird.

AWS CLI

So aktualisieren Sie ein Zeitleistenereignis

Im folgenden Beispiel für update-timeline-event wird die Uhrzeit des Ereignisvorfalls aktualisiert.

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"

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Vorfalldetails im Benutzerhandbuch zu Incident Manager.