Hay más AWS SDK ejemplos disponibles en el GitHub repositorio de AWS Doc SDK Examples
Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
Ejemplos de Incident Manager que utilizan AWS CLI
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el AWS Command Line Interface uso de 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.
Cada ejemplo incluye un enlace al código fuente completo, donde puede encontrar instrucciones sobre cómo configurar y ejecutar el código en su contexto.
Temas
Acciones
En el siguiente ejemplo de código se muestra cómo usar create-replication-set
.
- AWS CLI
-
Para crear el conjunto de réplicas
En el siguiente
create-replication-set
ejemplo, se crea el conjunto de réplicas 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 Uso del conjunto de replicación de Incident Manager en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte CreateReplicationSet
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar create-response-plan
.
- AWS CLI
-
Para crear un plan de respuesta
En el siguiente
create-response-plan
ejemplo, 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 Preparación de incidentes en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte CreateResponsePlan
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar create-timeline-event
.
- AWS CLI
-
Ejemplo 1: Para crear un evento de cronología personalizado
El siguiente
create-timeline-event
ejemplo crea un evento de cronología personalizado a la hora especificada del 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"
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: Para crear un evento en la cronología con una nota del incidente
En el siguiente
create-timeline-event
ejemplo, se crea un evento de cronología que aparece en el panel «Notas del 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-time2023-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 los detalles del incidente en la Guía del usuario del administrador de incidentes.
-
Para API obtener más información, consulte CreateTimelineEvent
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar delete-incident-record
.
- AWS CLI
-
Para eliminar un registro de incidentes
En el siguiente
delete-incident-record
ejemplo, 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 el seguimiento de incidentes en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte DeleteIncidentRecord
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar delete-replication-set
.
- AWS CLI
-
Para eliminar el conjunto de réplicas
En el siguiente
delete-replication-set
ejemplo, 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. Esto no se puede deshacer.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 Uso del conjunto de replicación de Incident Manager en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte DeleteReplicationSet
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar delete-resource-policy
.
- AWS CLI
-
Para eliminar una política de recursos
En el siguiente
delete-resource-policy
ejemplo, se elimina una política de recursos de un plan de respuesta. Esto revocará el acceso del director o la organización con la que se compartió 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 Trabajar con contactos y planes de respuesta compartidos en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte DeleteResourcePolicy
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar delete-response-plan
.
- AWS CLI
-
Para eliminar un plan de respuesta
En el siguiente
delete-response-plan
ejemplo, 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 Preparación de incidentes en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte DeleteResponsePlan
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar delete-timeline-event
.
- AWS CLI
-
Para eliminar un evento de la línea de tiempo
En el siguiente
delete-timeline-event
ejemplo, se elimina un evento de cronología 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 los detalles del incidente en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte DeleteTimelineEvent
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar get-incident-record
.
- AWS CLI
-
Para obtener un registro de incidentes
En el siguiente
get-incident-record
ejemplo, se obtienen detalles sobre el 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 los detalles del incidente en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte GetIncidentRecord
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar get-replication-set
.
- AWS CLI
-
Para obtener el conjunto de replicación
En el siguiente
get-replication-set
ejemplo, se obtienen los detalles del conjunto de replicación que Incident Manager utiliza 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 Uso del conjunto de replicación de Incident Manager en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte GetReplicationSet
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar get-resource-policies
.
- AWS CLI
-
Para enumerar las políticas de recursos de un plan de respuesta
En el siguiente
command-name
ejemplo, 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 Trabajar con contactos compartidos y planes de respuesta en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte GetResourcePolicies
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar get-response-plan
.
- AWS CLI
-
Para obtener detalles de un plan de respuesta
En el siguiente
command-name
ejemplo, se obtienen detalles sobre un plan de respuesta específico de tu AWS cuenta.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 Preparación ante incidentes en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte GetResponsePlan
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar get-timeline-event
.
- AWS CLI
-
Para obtener detalles de un evento de la cronología
En el siguiente
get-timeline-event
ejemplo, se devuelven los detalles del evento de la cronología 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 los detalles del incidente en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte GetTimelineEvent
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar list-incident-records
.
- AWS CLI
-
Para enumerar los registros de incidentes
En el siguiente
command-name
ejemplo, 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 la lista de incidentes en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte ListIncidentRecords
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar list-related-items
.
- AWS CLI
-
Para enumerar artículos relacionados
En el siguiente
list-related-items
ejemplo, 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 los detalles del incidente en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte ListRelatedItems
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar list-replication-sets
.
- AWS CLI
-
Para enumerar el conjunto de réplicas
En el siguiente
list-replication-set
ejemplo, se muestra el conjunto de réplicas que Incident Manager utiliza para replicar y cifrar los datos de su AWS cuenta.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 Uso del conjunto de replicación de Incident Manager en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte ListReplicationSets
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar list-response-plans
.
- AWS CLI
-
Para ver una lista de los planes de respuesta disponibles
En el siguiente
list-response-plans
ejemplo, 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 Preparación ante incidentes en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte ListResponsePlans
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar list-tags-for-resource
.
- AWS CLI
-
Para enumerar las etiquetas de un plan de respuesta
En el siguiente
list-tags-for-resource
ejemplo, 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 Etiquetado en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte ListTagsForResource
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar list-timeline-events
.
- AWS CLI
-
Para enumerar los eventos cronológicos de un incidente
En el siguiente
command-name
ejemplo, se enumeran los eventos cronológicos 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 los detalles del incidente en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte ListTimelineEvents
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar put-resource-policy
.
- AWS CLI
-
Para compartir un plan de respuesta y los incidentes
En el siguiente
command-name
ejemplo, se agrega una política de recursos a la Example-Response-Plan que se comparte el plan de respuesta y los incidentes asociados con el principal especificado.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 Trabajar con contactos y planes de respuesta compartidos en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte PutResourcePolicy
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar start-incident
.
- AWS CLI
-
Para iniciar un incidente
En el siguiente
start-incident
ejemplo, se inicia un incidente mediante 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 la creación de incidentes en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte StartIncident
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar tag-resource
.
- AWS CLI
-
Para etiquetar un plan de respuesta
El siguiente
tag-resource
ejemplo etiqueta un plan de respuesta especificado con el par clave-valor 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 Etiquetado en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte TagResource
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar untag-resource
.
- AWS CLI
-
Para eliminar etiquetas de un plan de respuesta
El siguiente
untag-resource
ejemplo elimina las 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 Etiquetado en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte UntagResource
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar update-deletion-protection
.
- AWS CLI
-
Para actualizar la protección contra la eliminación de conjuntos de replicación
En el siguiente
update-deletion-protection
ejemplo, se actualiza la protección contra la eliminación de su cuenta para evitar que se elimine la última región del conjunto de replicaciones.aws ssm-incidents update-deletion-protection \ --arn
"arn:aws:ssm-incidents::111122223333:replication-set/a2bcc5c9-0f53-8047-7fef-c20749989b40"
\ --deletion-protectedEste comando no genera ninguna salida.
Para obtener más información, consulte Uso del conjunto de replicación de Incident Manager en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte UpdateDeletionProtection
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar update-incident-record
.
- AWS CLI
-
Para actualizar un registro de incidentes
El siguiente
command-name
ejemplo 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 los detalles del incidente en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte UpdateIncidentRecord
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar update-related-items
.
- AWS CLI
-
Para actualizar un elemento relacionado con un incidente
En el siguiente
update-related-item
ejemplo, 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 los detalles del incidente en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte UpdateRelatedItems
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar update-replication-set
.
- AWS CLI
-
Para actualizar un conjunto de réplicas
En el siguiente
command-name
ejemplo, se elimina la región us-east-2 del conjunto de réplicas.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 Uso del conjunto de replicación de Incident Manager en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte UpdateReplicationSet
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar update-response-plan
.
- AWS CLI
-
Para actualizar un plan de respuesta
En el siguiente
update-response-plan
ejemplo, 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 Preparación ante incidentes en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte UpdateResponsePlan
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar update-timeline-event
.
- AWS CLI
-
Para actualizar un evento de la cronología
En el siguiente
update-timeline-event
ejemplo, 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 los detalles del incidente en la Guía del usuario de Incident Manager.
-
Para API obtener más información, consulte UpdateTimelineEvent
la Referencia de AWS CLI comandos.
-