Exemples Incident Manager avec l’AWS CLI - Exemples de code de kit AWS SDK

D’autres exemples de kits AWS SDK sont disponibles dans le référentiel GitHub AWS Doc SDK Examples.

Exemples Incident Manager avec l’AWS CLI

Les exemples de code suivants montrent comment réaliser des actions et mettre en œuvre des scénarios courants en utilisant l’AWS Command Line Interface avec Incident Manager.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.

Rubriques

Actions

L’exemple de code suivant montre comment utiliser create-replication-set.

AWS CLI

Pour créer l’ensemble de réplication

L’exemple create-replication-set suivant crée l’ensemble de réplication qu’utilise Incident Manager pour répliquer et chiffrer les données de votre compte Amazon Web Services. Cet exemple utilise les régions us-east-1 et us-east-2 lors de la création de l’ensemble de réplication.

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

Sortie :

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

Pour plus d’informations, consultez Utilisation de l’ensemble de réplications de gestion des incidents dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez CreateReplicationSet dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-response-plan.

AWS CLI

Pour créer un plan de réponse

L’exemple create-response-plan suivant crée un plan de réponse avec les détails spécifiés.

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

Sortie :

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

Pour plus d’informations, consultez Préparation aux incidents dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez CreateResponsePlan dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-timeline-event.

AWS CLI

Exemple 1 : pour créer un événement de chronologie personnalisé

L’exemple create-timeline-event suivant crée un événement de chronologie personnalisé à l’heure spécifiée de l’incident spécifié.

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"

Sortie :

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

Exemple 2 : pour créer un événement de chronologie avec une remarque d’incident

L’exemple create-timeline-event suivant crée un événement de chronologie répertorié dans le volet « Remarques d’incident ».

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

Sortie :

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

Pour plus d’informations, consultez Détails de l’incident dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez CreateTimelineEvent dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-incident-record.

AWS CLI

Pour supprimer un enregistrement d’incident

L’exemple delete-incident-record suivant supprime l’enregistrement de l’incident spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Suivi d’un incident dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez DeleteIncidentRecord dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-replication-set.

AWS CLI

Pour supprimer l’ensemble de réplication

L’exemple delete-replication-set suivant supprime l’ensemble de réplication de votre compte Amazon Web Services. La suppression de l’ensemble de réplication entraîne également la suppression de toutes les données d’Incident Manager. Cette action ne peut pas être annulée.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Utilisation de l’ensemble de réplications de gestion des incidents dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez DeleteReplicationSet dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-resource-policy.

AWS CLI

Pour supprimer une stratégie de ressources

L’exemple delete-resource-policy suivant supprime une politique de ressources d’un plan de réponse. Cette action révoque l’accès du principal ou de l’organisation avec lequel ou laquelle le plan de réponse a été partagé.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Utilisation de contacts partagés et de plans d’intervention dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez DeleteResourcePolicy dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-response-plan.

AWS CLI

Pour supprimer un plan de réponse

L’exemple delete-response-plan suivant supprime le plan de réponse spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Préparation aux incidents dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez DeleteResponsePlan dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-timeline-event.

AWS CLI

Pour supprimer un événement de chronologie

L’exemple delete-timeline-event suivant supprime un événement de chronologie personnalisé de l’enregistrement de l’incident spécifié.

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"

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Détails de l’incident dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez DeleteTimelineEvent dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-incident-record.

AWS CLI

Pour obtenir un enregistrement d’incident

L’exemple get-incident-record suivant obtient les informations de l’enregistrement de l’incident spécifié.

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

Sortie :

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

Pour plus d’informations, consultez Détails de l’incident dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez GetIncidentRecord dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-replication-set.

AWS CLI

Pour obtenir l’ensemble de réplication

L’exemple get-replication-set suivant obtient les détails du jeu de réplication utilisé par Incident Manager pour répliquer et chiffrer les données dans votre compte Amazon Web Services.

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

Sortie :

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

Pour plus d’informations, consultez Utilisation de l’ensemble de réplications de gestion des incidents dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez GetReplicationSet dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-resource-policies.

AWS CLI

Pour répertorier les politiques de ressources d’un plan de réponse

L’exemple command-name suivant répertorie les politiques de ressources associées au plan de réponse spécifié.

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

Sortie :

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

Pour plus d’informations, consultez Utilisation de contacts partagés et de plans d’intervention dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez GetResourcePolicies dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-response-plan.

AWS CLI

Pour obtenir les détails d’un plan de réponse

L’exemple command-name suivant obtient les détails d’un plan de réponse spécifié dans votre compte AWS.

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

Sortie :

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

Pour plus d’informations, consultez Préparation aux incidents dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez GetResponsePlan dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-timeline-event.

AWS CLI

Pour obtenir les détails d’un événement de chronologie

L’exemple get-timeline-event suivant renvoie les détails de l’événement de chronologie spécifié.

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"

Sortie :

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

Pour plus d’informations, consultez Détails de l’incident dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez GetTimelineEvent dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-incident-records.

AWS CLI

Pour répertorier les enregistrements d’incident

L’exemple command-name suivant répertorie les enregistrements d’incident dans votre compte Amazon Web Services.

aws ssm-incidents list-incident-records

Sortie :

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

Pour plus d’informations, consultez Liste des incidents dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez ListIncidentRecords dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-related-items.

AWS CLI

Pour répertorier les éléments associés

L’exemple list-related-items suivant répertorie les éléments associés de l’incident spécifié.

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

Sortie :

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

Pour plus d’informations, consultez Détails de l’incident dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez ListRelatedItems dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-replication-sets.

AWS CLI

Pour récupérer l’ensemble de réplication

L’exemple list-replication-set suivant répertorie le jeu de réplication utilisé par Incident Manager pour répliquer et chiffrer les données de votre compte AWS.

aws ssm-incidents list-replication-sets

Sortie :

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

Pour plus d’informations, consultez Utilisation de l’ensemble de réplications de gestion des incidents dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez ListReplicationSets dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-response-plans.

AWS CLI

Pour répertorier les plans de réponse disponibles

L’exemple list-response-plans suivant répertorie les plans d’intervention disponibles de votre compte Amazon Web Services.

aws ssm-incidents list-response-plans

Sortie :

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

Pour plus d’informations, consultez Préparation aux incidents dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez ListResponsePlans dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-tags-for-resource.

AWS CLI

Pour répertorier les balises d’un plan de réponse

L’exemple list-tags-for-resource suivant répertorie toutes les balises associées au plan de réponse spécifié.

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

Sortie :

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

Pour plus d’informations, consultez Balisage dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez ListTagsForResource dans la Référence des commandes AWS CLI.

L’exemple de code suivant montre comment utiliser list-timeline-events.

AWS CLI

Pour répertorier les événements de chronologie d’un incident

L’exemple command-name suivant répertorie les événements de chronologie de l’incident spécifié.

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

Sortie :

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

Pour plus d’informations, consultez Détails de l’incident dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez ListTimelineEvents dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser put-resource-policy.

AWS CLI

Pour partager un plan de réponse et des incidents

L’exemple command-name suivant ajoute une politique de ressources à Example-Response-Plan qui partage le plan de réponse et les incidents associés avec le principal spécifié.

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

Sortie :

{ "policyId": "be8b57191f0371f1c6827341aa3f0a03" }

Pour plus d’informations, consultez Utilisation de contacts partagés et de plans d’intervention dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez PutResourcePolicy dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser start-incident.

AWS CLI

Pour lancer un incident

L’exemple start-incident suivant démarre un incident en utilisant le plan de réponse spécifié.

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

Sortie :

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

Pour plus d’informations, consultez Création d’incidents dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez StartIncident dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser tag-resource.

AWS CLI

Pour baliser un plan de réponse

L’exemple tag-resource suivant balise un plan de réponse spécifié avec la paire clé-valeur de balise fournie.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Balisage dans le Guide de l’utilisateur Incident Manager.

  • Pour plus d’informations sur l’API, consultez TagResource dans la Référence des commandes AWS CLI.

L’exemple de code suivant montre comment utiliser untag-resource.

AWS CLI

Pour supprimer des balises d’un plan de réponse

L’exemple untag-resource suivant supprime les balises du plan de réponse spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Balisage dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez UntagResource dans la Référence des commandes AWS CLI.

L’exemple de code suivant montre comment utiliser update-deletion-protection.

AWS CLI

Pour mettre à jour la protection contre la suppression de l’ensemble de réplication

L’exemple update-deletion-protection suivant met à jour la protection contre la suppression dans votre compte afin de vous empêcher de supprimer la dernière région de votre jeu de réplication.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Utilisation de l’ensemble de réplications de gestion des incidents dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez UpdateDeletionProtection dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-incident-record.

AWS CLI

Pour mettre à jour un enregistrement d’incident

L’exemple command-name suivant résout l’incident spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Détails de l’incident dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez UpdateIncidentRecord dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-related-items.

AWS CLI

Pour mettre à jour un élément associé d’un incident

L’exemple update-related-item suivant supprime un élément associé de l’enregistrement de l’incident spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Détails de l’incident dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez UpdateRelatedItems dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-replication-set.

AWS CLI

Pour mettre à jour un ensemble de réplication

L’exemple command-name suivant supprime la région us-east-2 de l’ensemble de réplication.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Utilisation de l’ensemble de réplications de gestion des incidents dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez UpdateReplicationSet dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-response-plan.

AWS CLI

Pour mettre à jour un plan d’intervention

L’exemple update-response-plan suivant supprime un canal de chat du plan de réponse spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Préparation aux incidents dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez UpdateResponsePlan dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-timeline-event.

AWS CLI

Pour mettre à jour un événement de chronologie

L’exemple update-timeline-event suivant met à jour l’heure de l’événement.

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"

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Détails de l’incident dans le Guide de l’utilisateur Incident Manager.

  • Pour plus de détails sur l’API, consultez UpdateTimelineEvent dans la Référence des commandes de l’AWS CLI.