Esempi di Incident Manager che utilizzano AWS CLI

I seguenti esempi di codice mostrano come eseguire azioni e implementare scenari comuni utilizzando AWS Command Line Interface with Incident Manager.

Le azioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le azioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.

Ogni esempio include un link al codice sorgente completo, in cui vengono fornite le istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Azioni

Azioni

Il seguente esempio di codice mostra come utilizzarecreate-replication-set.

AWS CLI

Come creare il set di replica

L’esempio create-replication-set seguente crea il set di replica utilizzato da Strumento di gestione degli incidenti per replicare e crittografare i dati nell’account Amazon Web Services. In questo esempio vengono utilizzate le Regioni us-east-1 e us-east-2 durante la creazione del set di replica.


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

Output:


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

Per ulteriori informazioni, consulta Utilizzo del set di replica di Strumento di gestione degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta CreateReplicationSet AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzarecreate-response-plan.

AWS CLI

Come creare un piano di risposta

L’esempio create-response-plan seguente crea un piano di risposta con i dettagli specificati.


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

Output:


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

Per ulteriori informazioni, consulta Preparazione degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta CreateResponsePlan AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzarecreate-timeline-event.

AWS CLI

Esempio 1: come creare un evento della timeline personalizzato

L’esempio create-timeline-event seguente crea un evento della timeline personalizzato all’ora specificata dell’incidente specificato.


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"

Output:


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

Esempio 2: come creare un evento della timeline con una nota evento imprevisto

L’esempio create-timeline-event seguente crea un evento della timeline che viene visualizzato nel pannello “Note evento imprevisto”.


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

Output:


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

Per ulteriori informazioni, consulta Dettagli degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta CreateTimelineEvent AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzaredelete-incident-record.

AWS CLI

Come eliminare un record di incidente

L’esempio delete-incident-record seguente elimina il record di incidente specificato.


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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Monitoraggio degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta DeleteIncidentRecord AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzaredelete-replication-set.

AWS CLI

Come eliminare il set di repliche

L’esempio delete-replication-set seguente elimina il set di repliche dall’account Amazon Web Services. L’eliminazione del set di repliche elimina anche tutti i dati di Strumento di gestione degli incidenti. Questa operazione non può essere annullata.


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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Utilizzo del set di replica di Strumento di gestione degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta DeleteReplicationSet AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzaredelete-resource-policy.

AWS CLI

Come eliminare una policy delle risorse

L’esempio delete-resource-policy seguente elimina una policy delle risorse da un piano di risposta. In questo modo verrà revocato l’accesso al principale o all’organizzazione con cui il piano di risposta era stato condiviso.


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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Utilizzo di contatti condivisi e piani di risposta nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta DeleteResourcePolicy AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzaredelete-response-plan.

AWS CLI

Come eliminare un piano di risposta

L’esempio delete-response-plan seguente elimina il piano di risposta specificato.


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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Preparazione degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta DeleteResponsePlan AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzaredelete-timeline-event.

AWS CLI

Come eliminare un evento della timeline

L’esempio delete-timeline-event seguente elimina un evento della timeline personalizzato dal record dell’incidente specificato.


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"

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Dettagli degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta DeleteTimelineEvent AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareget-incident-record.

AWS CLI

Come ottenere un record di incidente

L’esempio get-incident-record seguente ottiene dettagli sul record dell’incidente specificato.


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

Output:


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

Per ulteriori informazioni, consulta Dettagli degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta GetIncidentRecord AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareget-replication-set.

AWS CLI

Come ottenere il set di replica

L’esempio get-replication-set seguente ottiene i dettagli del set di replica utilizzato da Strumento di gestione degli incidenti per replicare e crittografare i dati nel tuo account Amazon Web Services.


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

Output:


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

Per ulteriori informazioni, consulta Utilizzo del set di replica di Strumento di gestione degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta GetReplicationSet AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareget-resource-policies.

AWS CLI

Come elencare le policy delle risorse per un piano di risposta

L’esempio command-name seguente elenca le policy delle risorse associate al piano di risposta specificato.


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

Output:


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

Per ulteriori informazioni, consulta Utilizzo di contatti condivisi e piani di risposta nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta GetResourcePolicies AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareget-response-plan.

AWS CLI

Come ottenere i dettagli di un piano di risposta

L'command-nameesempio seguente fornisce dettagli su un piano di risposta specifico nel tuo AWS account.


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

Output:


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

Per ulteriori informazioni, consulta Preparazione degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta GetResponsePlan AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareget-timeline-event.

AWS CLI

Come ottenere i dettagli di un evento della timeline

L’esempio get-timeline-event seguente restituisce i dettagli dell’evento della timeline specificato.


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"

Output:


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

Per ulteriori informazioni, consulta Dettagli degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta GetTimelineEvent AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzarelist-incident-records.

AWS CLI

Come elencare i record degli incidenti

L’esempio command-name seguente elenca i record degli incidenti nell’account Amazon Web Services.


aws ssm-incidents list-incident-records

Output:


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

Per ulteriori informazioni, consulta Elenco di incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta ListIncidentRecords AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzarelist-related-items.

AWS CLI

Come elencare gli elementi correlati

L’esempio list-related-items seguente elenca gli elementi correlati dell’incidente specificato.


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

Output:


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

Per ulteriori informazioni, consulta Dettagli degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta ListRelatedItems AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzarelist-replication-sets.

AWS CLI

Come elencare il set di replica

L'list-replication-setesempio seguente elenca il set di replica utilizzato da Incident Manager per replicare e crittografare i dati nell'account. AWS


aws ssm-incidents list-replication-sets

Output:


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

Per ulteriori informazioni, consulta Utilizzo del set di replica di Strumento di gestione degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta Command ListReplicationSetsReference AWS CLI .

Il seguente esempio di codice mostra come utilizzarelist-response-plans.

AWS CLI

Come elencare i piani di risposta disponibili

L’esempio list-response-plans seguente elenca i piani di risposta disponibili nell’account Amazon Web Services.


aws ssm-incidents list-response-plans

Output:


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

Per ulteriori informazioni, consulta Preparazione degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta ListResponsePlans AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzarelist-tags-for-resource.

AWS CLI

Come elencare i tag per un piano di risposta

L’esempio list-tags-for-resource seguente elenca i tag associati al piano di risposta specificato.


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

Output:


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

Per ulteriori informazioni, consulta Tagging nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta ListTagsForResource AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzarelist-timeline-events.

AWS CLI

Come elencare gli eventi della timeline di un incidente

L’esempio command-name seguente elenca gli eventi della timeline dell’incidente specificato.


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

Output:


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

Per ulteriori informazioni, consulta Dettagli degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta ListTimelineEvents AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareput-resource-policy.

AWS CLI

Come condividere un piano di risposta e gli incidenti

L'command-nameesempio seguente aggiunge una politica delle risorse a Example-Response-Plan quella che condivide il piano di risposta e gli incidenti associati con il principale specificato.


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

Output:


{
    "policyId": "be8b57191f0371f1c6827341aa3f0a03"
}

Per ulteriori informazioni, consulta Utilizzo di contatti condivisi e piani di risposta nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, vedere PutResourcePolicyin AWS CLI Command Reference.

Il seguente esempio di codice mostra come utilizzarestart-incident.

AWS CLI

Come avviare un incidente

L’esempio start-incident seguente avvia un incidente utilizzando il piano di risposta specificato.


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

Output:


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

Per ulteriori informazioni, consulta Creazione di incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta StartIncident AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzaretag-resource.

AWS CLI

Come aggiungere tag a un piano di risposta

L’esempio tag-resource seguente aggiunge tag a un piano di risposta specificato utilizzando la coppia chiave-valore del tag fornita.


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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Tagging nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta TagResource AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareuntag-resource.

AWS CLI

Come rimuovere tag da un piano di risposta

L’esempio untag-resource seguente rimuove i tag specificati dal piano di risposta.


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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Tagging nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta UntagResource AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareupdate-deletion-protection.

AWS CLI

Come aggiornare la protezione dall’eliminazione del set

L’esempio update-deletion-protection seguente aggiorna la protezione dall’eliminazione nell’account per impedirti di eliminare l’ultima Regione nel tuo set di replica.


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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Utilizzo del set di replica di Strumento di gestione degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta UpdateDeletionProtection AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareupdate-incident-record.

AWS CLI

Come aggiornare un record di incidente

L’esempio command-name seguente risolve l’incidente specificato.


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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Dettagli degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta UpdateIncidentRecord AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareupdate-related-items.

AWS CLI

Come aggiornare un elemento correlato agli incidenti

L’esempio update-related-item seguente rimuove un elemento correlato dal record dell’incidente specificato.


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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Dettagli degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta UpdateRelatedItems AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareupdate-replication-set.

AWS CLI

Come aggiornare un set di replica

L’esempio command-name seguente elimina la Regione us-east-2 dal set di replica.


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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Utilizzo del set di replica di Strumento di gestione degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta UpdateReplicationSet AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareupdate-response-plan.

AWS CLI

Come aggiornare un piano di risposta

L’esempio update-response-plan seguente rimuove un canale di chat dal piano di risposta specificato.


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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Preparazione degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta UpdateResponsePlan AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareupdate-timeline-event.

AWS CLI

Come aggiornare un evento della timeline

L’esempio update-timeline-event seguente aggiorna l’ora in cui si è verificato l’evento.


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"

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Dettagli degli incidenti nella Guida per l’utente di Strumento di gestione degli incidenti.

Per i dettagli sull'API, consulta UpdateTimelineEvent AWS CLICommand Reference.

Avvertimento JavaScript è disabilitato o non è disponibile nel tuo browser.

Per usare la documentazione AWS, JavaScript deve essere abilitato. Consulta le pagine della guida del browser per le istruzioni.

Convenzioni dei documenti

Image Builder

Contatti di Incident Manager