Ejemplos de Incident Manager que utilizan la AWS CLI - AWS Command Line Interface
Acciones

Ejemplos de Incident Manager que utilizan la AWS CLI

En los siguientes ejemplos de código, se muestra cómo realizar acciones e implementar escenarios comunes usando AWS Command Line Interface con Incident Manager.

Las acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las funciones de servicio individuales, es posible ver las acciones en contexto en los escenarios relacionados.

En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.

Acciones

En el siguiente ejemplo de código, se muestra cómo utilizar create-replication-set.

AWS CLI

Para crear el conjunto de replicación

En el siguiente ejemplo de create-replication-set, se crea el conjunto de replicación que Incident Manager utiliza para replicar y cifrar los datos de su cuenta de Amazon Web Services. En este ejemplo, se utilizan las regiones us-east-1 y us-east-2 al crear el conjunto de replicación.

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

Salida:

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

Para obtener más información, consulte What Is AWS Systems Manager Incident Manager? en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte CreateReplicationSet en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar create-response-plan.

AWS CLI

Para crear un plan de respuesta

En el siguiente ejemplo de create-response-plan, se crea un plan de respuesta con los detalles 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"]'

Salida:

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

Para obtener más información, consulte Incident preparation en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte CreateResponsePlan en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar create-timeline-event.

AWS CLI

Ejemplo 1: creación de un evento de escala de tiempo personalizado

En el siguiente ejemplo de create-timeline-event, se crea un evento de escala de tiempo personalizado a la hora especificada del incidente indicado.

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"

Salida:

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

Ejemplo 2: creación de un evento de escala de tiempo con una nota del incidente

En el siguiente ejemplo de create-timeline-event, se crea un evento de escala de tiempo que aparece en el panel Notas de incidentes.

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

Salida:

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

Para obtener más información, consulte Incident details en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte CreateTimelineEvent en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar delete-incident-record.

AWS CLI

Para eliminar un registro de incidentes

En el siguiente ejemplo de delete-incident-record, se elimina el 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 no genera ninguna salida.

Para obtener más información, consulte Incident tracking en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte DeleteIncidentRecord en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar delete-replication-set.

AWS CLI

Para eliminar el conjunto de replicación

En el siguiente ejemplo de delete-replication-set, se elimina el conjunto de replicación de su cuenta de Amazon Web Services. Al eliminar el conjunto de replicación también se eliminan todos los datos de Incident Manager. Esta acción no se puede revertir.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte What Is AWS Systems Manager Incident Manager? en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte DeleteReplicationSet en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar delete-resource-policy.

AWS CLI

Para eliminar una política de recursos

En el siguiente ejemplo de delete-resource-policy, se elimina una política de recursos de un plan de respuesta. Esto revocará el acceso de la entidad principal o la organización con la que se ha compartido el plan de respuesta.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Working with shared contacts and response plans en la Guía del usuario de Incident Manager.

  • Para obtener detalles sobre la API, consulte DeleteResourcePolicy en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar delete-response-plan.

AWS CLI

Para eliminar un plan de respuesta

En el siguiente ejemplo de delete-response-plan, se elimina el plan de respuesta especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Incident preparation en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte DeleteResponsePlan en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar delete-timeline-event.

AWS CLI

Para eliminar un evento de escala de tiempo

En el siguiente ejemplo de delete-timeline-event, se elimina un evento de escala de tiempo personalizado del registro de incidentes 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 no genera ninguna salida.

Para obtener más información, consulte Incident details en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte DeleteTimelineEvent en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar get-incident-record.

AWS CLI

Para obtener un registro de incidentes

En el siguiente ejemplo de get-incident-record, se obtiene información del registro de incidentes especificado.

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

Salida:

{
    "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 obtener más información, consulte Incident details en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte GetIncidentRecord en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar get-replication-set.

AWS CLI

Para obtener el conjunto de replicación

En el siguiente ejemplo de get-replication-set, se obtiene detalles del conjunto de replicación que utiliza Incident Manager para replicar y cifrar los datos de su cuenta de Amazon Web Services.

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

Salida:

{
    "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 obtener más información, consulte What Is AWS Systems Manager Incident Manager? en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte GetReplicationSet en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar get-resource-policies.

AWS CLI

Para enumerar las políticas de recursos de un plan de respuesta

En el siguiente ejemplo de command-name, se enumeran las políticas de recursos asociadas al plan de respuesta especificado.

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

Salida:

{
    "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 obtener más información, consulte Working with shared contacts and response plans en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte GetResourcePolicies en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar get-response-plan.

AWS CLI

Para obtener detalles de un plan de respuesta

En el siguiente ejemplo de command-name, se obtienen detalles sobre un plan de respuesta específico de su cuenta de AWS.

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

Salida:

{
    "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 obtener más información, consulte Incident preparation en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte GetResponsePlan en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar get-timeline-event.

AWS CLI

Para obtener detalles de un evento de escala de tiempo

En el siguiente ejemplo de get-timeline-event, se devuelven los detalles del evento de escala de tiempo 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"

Salida:

{
    "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 obtener más información, consulte Incident details en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte GetTimelineEvent en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar list-incident-records.

AWS CLI

Para enumerar registros de incidentes

En el siguiente ejemplo de command-name, se enumeran los registros de incidentes de su cuenta de Amazon Web Services.

aws ssm-incidents list-incident-records

Salida:

{
    "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 obtener más información, consulte Incident list en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte ListIncidentRecords en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar list-related-items.

AWS CLI

Para enumerar elementos relacionados

En el siguiente ejemplo de list-related-items, se enumeran los elementos relacionados con el 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"

Salida:

{
    "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 obtener más información, consulte Incident details en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte ListRelatedItems en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar list-replication-sets.

AWS CLI

Para enumerar el conjunto de replicación

En el siguiente ejemplo de list-replication-set, se enumera el conjunto de replicación que utiliza Incident Manager para replicar y cifrar los datos de su cuenta de AWS.

aws ssm-incidents list-replication-sets

Salida:

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

Para obtener más información, consulte What Is AWS Systems Manager Incident Manager? en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte ListReplicationSets en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar list-response-plans.

AWS CLI

Para ver una lista de los planes de respuesta disponibles

En el siguiente ejemplo de list-response-plans, se enumeran los planes de respuesta disponibles en su cuenta de Amazon Web Services.

aws ssm-incidents list-response-plans

Salida:

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

Para obtener más información, consulte Incident preparation en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte ListResponsePlans en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar list-tags-for-resource.

AWS CLI

Para enumerar las etiquetas de un plan de respuesta

En el siguiente ejemplo de list-tags-for-resource, se enumeran las etiquetas asociadas al plan de respuesta especificado.

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

Salida:

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

Para obtener más información, consulte Tagging en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte ListTagsForResource en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar list-timeline-events.

AWS CLI

Para enumerar los eventos de escala de tiempo de un incidente

En el siguiente ejemplo de command-name, se enumeran los eventos de escala de tiempo del 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"

Salida:

{
    "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 obtener más información, consulte Incident details en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte ListTimelineEvents en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar put-resource-policy.

AWS CLI

Para compartir un plan de respuesta y los incidentes

En el siguiente ejemplo de command-name, se agrega una política de recursos al Example-Response-Plan que comparte el plan de respuesta y los incidentes asociados a la entidad 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/*\"]}]}"

Salida:

{
    "policyId": "be8b57191f0371f1c6827341aa3f0a03"
}

Para obtener más información, consulte Working with shared contacts and response plans en la Guía del usuario de Incident Manager.

  • Para obtener detalles sobre la API, consulte PutResourcePolicy en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar start-incident.

AWS CLI

Para iniciar un incidente

En el siguiente ejemplo de start-incident, se inicia un incidente con el plan de respuesta especificado.

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

Salida:

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

Para obtener más información, consulte Incident creation en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte StartIncident en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar tag-resource.

AWS CLI

Para etiquetar un plan de respuesta

En el siguiente ejemplo de tag-resource, se etiqueta un plan de respuesta especificado con el par clave-valor de etiquetas proporcionado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Tagging en la Guía del usuario de Incident Manager.

  • Para ver los detalles de la API, consulte TagResource en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar untag-resource.

AWS CLI

Para eliminar etiquetas de un plan de respuesta

En el siguiente ejemplo de untag-resource, se eliminan la etiquetas especificadas del plan de respuesta.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Tagging en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte UntagResource en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar update-deletion-protection.

AWS CLI

Para actualizar la protección de eliminación de conjuntos de reproducción

En el siguiente ejemplo de update-deletion-protection, se actualiza la protección contra la eliminación de su cuenta para evitar que se elimine la última región del conjunto de replicación.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte What Is AWS Systems Manager Incident Manager? en la Guía del usuario de Incident Manager.

En el siguiente ejemplo de código, se muestra cómo utilizar update-incident-record.

AWS CLI

Para actualizar un registro de incidentes

En el siguiente ejemplo de command-name, se resuelve el 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 no genera ninguna salida.

Para obtener más información, consulte Incident details en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte UpdateIncidentRecord en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar update-related-items.

AWS CLI

Para actualizar un elemento relacionado con un incidente

En el siguiente ejemplo de update-related-item, se elimina un elemento relacionado del registro de incidentes 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 no genera ninguna salida.

Para obtener más información, consulte Incident details en la Guía del usuario de Incident Manager.

  • Para obtener información acerca de la API, consulte UpdateRelatedItems en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar update-replication-set.

AWS CLI

Para actualizar un conjunto de replicación

En el siguiente ejemplo de command-name, se elimina la región us-east-2 del conjunto de replicación.

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 no genera ninguna salida.

Para obtener más información, consulte What Is AWS Systems Manager Incident Manager? en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte UpdateReplicationSet en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar update-response-plan.

AWS CLI

Para actualizar un plan de respuesta

En el siguiente ejemplo de update-response-plan, se elimina un canal de chat del plan de respuesta especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Incident preparation en la Guía del usuario de Incident Manager.

  • Para obtener información acerca de la API, consulte UpdateResponsePlan en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar update-timeline-event.

AWS CLI

Para actualizar un evento de escala de tiempo

En el siguiente ejemplo de update-timeline-event, se actualiza la hora a la que se produjo el 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"

Este comando no genera ninguna salida.

Para obtener más información, consulte Incident details en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte UpdateTimelineEvent en la Referencia de comandos de la AWS CLI.