Exemplos do Incident Manager usando a AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Incident Manager.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar funções de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.

Tópicos

Ações

Ações

O código de exemplo a seguir mostra como usar create-replication-set.

AWS CLI

Para criar o conjunto de replicação

O exemplo create-replication-set a seguir cria o conjunto de replicação que o Incident Manager usa para replicar e criptografar dados em sua conta da Amazon Web Services. Este exemplo usa as regiões us-east-1 e us-east-2 ao criar o conjunto de replicação.


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

Saída:


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

Para obter mais informações, consulte Usar o conjunto de replicação do Incident Manager no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte CreateReplicationSet na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-response-plan.

AWS CLI

Para criar um plano de resposta

O exemplo create-response-plan a seguir cria um plano de resposta com os detalhes especificados.


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

Saída:


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

Para obter mais informações, consulte Preparação para incidentes no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte CreateResponsePlan na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-timeline-event.

AWS CLI

Exemplo 1: criar um evento do cronograma personalizado

O exemplo create-timeline-event a seguir cria um evento do cronograma personalizado no horário especificado no incidente especificado.


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"

Saída:


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

Exemplo 2: criar um evento do cronograma com uma nota de incidente

O exemplo create-timeline-event a seguir cria um evento do cronograma listado no painel “Notas do incidente”.


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

Saída:


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

Para obter mais informações, consulte Detalhes de incidentes no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte CreateTimelineEvent na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-incident-record.

AWS CLI

Para excluir um registro de incidente

O exemplo delete-incident-record a seguir exclui o registro de incidentes especificado.


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

Este comando não produz saída.

Para obter mais informações, consulte Rastreamento de incidentes no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte DeleteIncidentRecord na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-replication-set.

AWS CLI

Para excluir o conjunto de replicação

O exemplo delete-replication-set a seguir exclui o conjunto de replicação da sua conta da Amazon Web Services. A exclusão do conjunto de replicação também exclui todos os dados do Incident Manager. Essa ação não pode ser desfeita.


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

Este comando não produz saída.

Para obter mais informações, consulte Usar o conjunto de replicação do Incident Manager no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte DeleteReplicationSet na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-resource-policy.

AWS CLI

Para excluir uma política de recurso

O exemplo delete-resource-policy a seguir exclui uma política de recursos de um plano de resposta. Isso revogará o acesso da entidade principal ou da organização com a qual o plano de resposta foi compartilhado.


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

Este comando não produz saída.

Para obter mais informações, consulte Como trabalhar com contatos e planos de resposta no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte DeleteResourcePolicy na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-response-plan.

AWS CLI

Para excluir um plano de resposta

O exemplo delete-response-plan a seguir exclui o plano de resposta especificado.


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

Este comando não produz saída.

Para obter mais informações, consulte Preparação para incidentes no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte DeleteResponsePlan na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-timeline-event.

AWS CLI

Para excluir um evento do cronograma

O exemplo delete-timeline-event a seguir exclui um evento do cronograma personalizado do registro de incidente especificado.


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"

Este comando não produz saída.

Para obter mais informações, consulte Detalhes de incidentes no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte DeleteTimelineEvent na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-incident-record.

AWS CLI

Para obter um registro de incidentes

O exemplo get-incident-record a seguir obtém detalhes sobre o registro de incidente especificado.


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

Saída:


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

Para obter mais informações, consulte Detalhes de incidentes no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte GetIncidentRecord na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-replication-set.

AWS CLI

Para obter o conjunto de replicação

O exemplo get-replication-set a seguir obtém os detalhes do conjunto de replicação que o Incident Manager usa para replicar e criptografar dados em sua conta da Amazon Web Services.


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

Saída:


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

Para obter mais informações, consulte Usar o conjunto de replicação do Incident Manager no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte GetReplicationSet na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-resource-policies.

AWS CLI

Para listar políticas de recursos para um plano de resposta

O exemplo command-name a seguir lista as políticas de recursos associadas ao plano de resposta especificado.


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

Saída:


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

Para obter mais informações, consulte Como trabalhar com contatos e planos de resposta no Guia do usuário do Incident Manager.

Para receber detalhes da API, consulte GetResourcePolicies na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-response-plan.

AWS CLI

Para obter detalhes de um plano de resposta

O exemplo command-name a seguir mostra detalhes sobre um plano de resposta específico em sua conta da AWS.


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

Saída:


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

Para obter mais informações, consulte Preparação para incidentes no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte GetResponsePlan na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-timeline-event.

AWS CLI

Para obter detalhes de um evento do cronograma

O exemplo get-timeline-event a seguir retorna os detalhes sobre o evento do cronograma especificado.


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"

Saída:


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

Para obter mais informações, consulte Detalhes de incidentes no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte GetTimelineEvent na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-incident-records.

AWS CLI

Para listar registros de incidentes

O exemplo command-name a seguir lista os registros de incidentes na sua conta da Amazon Web Services.


aws ssm-incidents list-incident-records

Saída:


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

Para obter mais informações, consulte Lista de incidentes no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte ListIncidentRecords na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-related-items.

AWS CLI

Para listar os itens relacionados

O exemplo list-related-items a seguir lista os itens relacionados ao incidente especificado.


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

Saída:


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

Para obter mais informações, consulte Detalhes de incidentes no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte ListRelatedItems na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-replication-sets.

AWS CLI

Para listar o conjunto de replicação

O exemplo list-replication-set a seguir lista o conjunto de replicação que o Incident Manager usa para replicar e criptografar dados em sua conta da AWS.


aws ssm-incidents list-replication-sets

Saída:


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

Para obter mais informações, consulte Usar o conjunto de replicação do Incident Manager no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte ListReplicationSets na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-response-plans.

AWS CLI

Para listar os planos de resposta disponíveis

O exemplo list-response-plans a seguir lista os planos de resposta disponíveis na sua conta da Amazon Web Services.


aws ssm-incidents list-response-plans

Saída:


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

Para obter mais informações, consulte Preparação para incidentes no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte ListResponsePlans na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-tags-for-resource.

AWS CLI

Para listar tags para um plano de resposta

O exemplo list-tags-for-resource a seguir lista as tags associadas ao plano de resposta especificado.


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

Saída:


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

Para obter mais informações, consulte Marcações no Guia do usuário do Incident Manager.

Para ver detalhes sobre a API, consulte ListTagsForResource na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-timeline-events.

AWS CLI

Para listar os eventos do cronograma de um incidente

O exemplo command-name a seguir lista os eventos do cronograma do incidente especificado.


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

Saída:


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

Para obter mais informações, consulte Detalhes de incidentes no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte ListTimelineEvents na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar put-resource-policy.

AWS CLI

Como compartilhar um plano de resposta e incidentes

O exemplo command-name a seguir adiciona uma política de recursos ao Example-Response-Plan que compartilha o plano de resposta e os incidentes associados com a entidade principal especificada.


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

Saída:


{
    "policyId": "be8b57191f0371f1c6827341aa3f0a03"
}

Para obter mais informações, consulte Como trabalhar com contatos e planos de resposta no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte PutResourcePolicy na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar start-incident.

AWS CLI

Para iniciar um incidente

O exemplo start-incident a seguir inicia um incidente usando o plano de resposta especificado.


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

Saída:


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

Para obter mais informações, consulte Criação de incidentes no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte StartIncident na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar tag-resource.

AWS CLI

Como marcar um plano de resposta

O exemplo tag-resource a seguir marca um plano de resposta especificado com o par de chave-valor de tag fornecido.


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

Este comando não produz saída.

Para obter mais informações, consulte Marcações no Guia do usuário do Incident Manager.

Para obter detalhes da API, consulte TagResource na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar untag-resource.

AWS CLI

Para remover as tags de um plano de resposta

O exemplo untag-resource a seguir remove as tags especificadas do plano de resposta.


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

Este comando não produz saída.

Para obter mais informações, consulte Marcações no Guia do usuário do Incident Manager.

Para obter detalhes sobre a API, consulte UntagResource na AWS CLI Command Reference.

O código de exemplo a seguir mostra como usar update-deletion-protection.

AWS CLI

Para atualizar a proteção contra a exclusão de grupos de replicações

O exemplo update-deletion-protection a seguir atualiza a proteção contra exclusão em sua conta para evitar que você exclua a última região em seu conjunto de replicação.


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

Este comando não produz saída.

Para obter mais informações, consulte Usar o conjunto de replicação do Incident Manager no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte UpdateDeletionProtection na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-incident-record.

AWS CLI

Para atualizar um registro de incidentes

O exemplo command-name a seguir resolve o incidente especificado.


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

Este comando não produz saída.

Para obter mais informações, consulte Detalhes de incidentes no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte UpdateIncidentRecord na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-related-items.

AWS CLI

Para atualizar um item relacionado a incidentes

O exemplo update-related-item a seguir remove um item relacionado do registro de incidente especificado.


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

Este comando não produz saída.

Para obter mais informações, consulte Detalhes de incidentes no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte UpdateRelatedItems na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-replication-set.

AWS CLI

Para atualizar um conjunto de replicação

O exemplo command-name a seguir exclui a região us-east-2 do conjunto de replicação.


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

Este comando não produz saída.

Para obter mais informações, consulte Usar o conjunto de replicação do Incident Manager no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte UpdateReplicationSet na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-response-plan.

AWS CLI

Para criar um plano de resposta

O exemplo update-response-plan a seguir remove um canal de chat do plano de resposta especificado.


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

Este comando não produz saída.

Para obter mais informações, consulte Preparação para incidentes no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte UpdateResponsePlan na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-timeline-event.

AWS CLI

Para atualizar um evento do cronograma

O exemplo update-timeline-event a seguir atualiza a hora em que o evento ocorreu.


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"

Este comando não produz saída.

Para obter mais informações, consulte Detalhes de incidentes no Guia do usuário do Incident Manager.

Para ver detalhes da API, consulte UpdateTimelineEvent na Referência de comandos da AWS CLI.

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Image Builder

Incident Manager Contacts