Exemples de contacts du gestionnaire d'incidents utilisant AWS CLI - AWS Command Line Interface

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Exemples de contacts du gestionnaire d'incidents utilisant AWS CLI

Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l' AWS Command Line Interface aide des contacts du gestionnaire d'incidents.

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 utiliseraccept-page.

AWS CLI

Pour accepter une page pendant un engagement

L’exemple accept-page suivant utilise un code d’acceptation envoyé au canal de contact pour accepter une page.

aws ssm-contacts accept-page \ --page-id "arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3" \ --accept-type READ \ --accept-code 425440

Cette commande ne produit aucun résultat.

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

  • Pour plus de détails sur l'API, reportez-vous AcceptPageà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliseractivate-contact-channel.

AWS CLI

Pour activer le canal de contact d’un contact

L’exemple activate-contact-channel suivant active un canal de contact et le rend utilisable dans le cadre d’un incident.

aws ssm-contacts activate-contact-channel \ --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d" \ --activation-code "466136"

Cette commande ne produit aucune sortie.

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

  • Pour plus de détails sur l'API, reportez-vous ActivateContactChannelà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercommand-name.

AWS CLI

Pour supprimer un contact

L’exemple command-name suivant supprime un contact. Le contact ne sera plus accessible à partir des plans d’escalade qui y font référence.

aws ssm-contacts delete-contact \ --contact-id "arn:aws:ssm-contacts:us-east-1:682428703967:contact/alejr"

Cette commande ne produit aucune sortie.

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

  • Pour plus de détails sur l'API, reportez-vous CommandNameà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-contact-channel.

AWS CLI

Pour créer un canal de contact

L’exemple suivant crée un canal de contact de type SMS pour le contact Akua Mansa. Des canaux de contact de type SMS, E-MAIL ou VOIX peuvent être créés.

aws ssm-contacts create-contact-channel \ --contact-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \ --name "akuas sms-test" \ --type SMS \ --delivery-address '{"SimpleAddress": "+15005550199"}'

Sortie :

{ "ContactChannelArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/02f506b9-ea5d-4764-af89-2daa793ff024" }

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

  • Pour plus de détails sur l'API, reportez-vous CreateContactChannelà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-contact.

AWS CLI

Pour créer un contact

L’exemple create-contact suivant crée un contact dans votre environnement avec un plan vierge. Le plan peut être mis à jour une fois les canaux de contact créés. Utilisez la create-contact-channel commande avec l'ARN de sortie de cette commande. Après avoir créé les canaux de contact de ce contact, utilisez update-contact pour mettre à jour le plan.

aws ssm-contacts create-contact \ --alias "akuam" \ --display-name "Akua Mansa" \ --type PERSONAL \ --plan '{"Stages": []}'

Sortie :

{ "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" }

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

  • Pour plus de détails sur l'API, reportez-vous CreateContactà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdeactivate-contact-channel.

AWS CLI

Pour désactiver un canal de contact

L’exemple deactivate-contact-channel suivant désactive un canal de contact. Si un canal de contact est désactivé, il ne sera plus paginé en cas d’incident. Vous pouvez également réactiver un canal de contact à tout moment à l’aide de la commande activate-contact-channel.

aws ssm-contacts deactivate-contact-channel \ --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"

Cette commande ne produit aucune sortie.

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

  • Pour plus de détails sur l'API, reportez-vous DeactivateContactChannelà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-contact-channel.

AWS CLI

Pour supprimer un canal de contact

L’exemple delete-contact-channel suivant supprime un canal de contact. Si un canal de contact est supprimé, il ne sera pas paginé en cas d’incident.

aws ssm-contacts delete-contact-channel \ --contact-channel-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/13149bad-52ee-45ea-ae1e-45857f78f9b2"

Cette commande ne produit aucune sortie.

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

  • Pour plus de détails sur l'API, reportez-vous DeleteContactChannelà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-contact.

AWS CLI

Pour supprimer un contact

L’exemple delete-contact suivant supprime un contact. Le contact ne sera plus accessible à partir des plans d’escalade qui y font référence.

aws ssm-contacts delete-contact \ --contact-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr"

Cette commande ne produit aucune sortie.

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

  • Pour plus de détails sur l'API, reportez-vous DeleteContactà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-engagement.

AWS CLI

Pour décrire les détails d’un engagement

L’exemple describe-engagement suivant décrit les détails d’un engagement à un plan de contact ou d’escalade. L’objet et le contenu sont envoyés aux canaux de contact.

aws ssm-contacts describe-engagement \ --engagement-id "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"

Sortie :

{ "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", "Sender": "cli", "Subject": "cli-test", "Content": "Testing engagements via CLI", "PublicSubject": "cli-test", "PublicContent": "Testing engagements va CLI", "StartTime": "2021-05-18T18:25:41.151000+00:00" }

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

  • Pour plus de détails sur l'API, reportez-vous DescribeEngagementà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-page.

AWS CLI

Pour décrire les détails d’une page à un canal de contact

L’exemple describe-page suivant décrit les détails d’une page à un canal de contact. La page inclut l’objet et le contenu fournis.

aws ssm-contacts describe-page \ --page-id "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93"

Sortie :

{ "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Sender": "cli", "Subject": "cli-test", "Content": "Testing engagements via CLI", "PublicSubject": "cli-test", "PublicContent": "Testing engagements va CLI", "SentTime": "2021-05-18T18:43:29.301000+00:00", "ReadTime": "2021-05-18T18:43:55.708000+00:00", "DeliveryTime": "2021-05-18T18:43:55.265000+00:00" }

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

  • Pour plus de détails sur l'API, reportez-vous DescribePageà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-contact-channel.

AWS CLI

Pour répertorier les détails d’un canal de contact

L’exemple get-contact-channel suivant répertorie les détails d’un canal de contact.

aws ssm-contacts get-contact-channel \ --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"

Sortie :

{ "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", "Name": "akuas sms", "Type": "SMS", "DeliveryAddress": { "SimpleAddress": "+15005550199" }, "ActivationStatus": "ACTIVATED" }

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

  • Pour plus de détails sur l'API, reportez-vous GetContactChannelà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-contact-policy.

AWS CLI

Pour répertorier les stratégies de ressources d’un contact

L’exemple get-contact-policy suivant répertorie les stratégies de ressources associées au contact spécifié.

aws ssm-contacts get-contact-policy \ --contact-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"

Sortie :

{ "ContactArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"SharePolicyForDocumentationDralia\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"222233334444\"},\"Action\":[\"ssm-contacts:GetContact\",\"ssm-contacts:StartEngagement\",\"ssm-contacts:DescribeEngagement\",\"ssm-contacts:ListPagesByEngagement\",\"ssm-contacts:StopEngagement\"],\"Resource\":[\"arn:aws:ssm-contacts:*:111122223333:contact/akuam\",\"arn:aws:ssm-contacts:*:111122223333:engagement/akuam/*\"]}]}" }

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, reportez-vous GetContactPolicyà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-contact.

AWS CLI

Exemple 1 : pour décrire un plan de contact

L’exemple get-contact suivant décrit un contact.

aws ssm-contacts get-contact \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"

Sortie :

{ "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Alias": "akuam", "DisplayName": "Akua Mansa", "Type": "PERSONAL", "Plan": { "Stages": [ { "DurationInMinutes": 5, "Targets": [ { "ChannelTargetInfo": { "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65", "RetryIntervalInMinutes": 1 } } ] }, { "DurationInMinutes": 5, "Targets": [ { "ChannelTargetInfo": { "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad", "RetryIntervalInMinutes": 1 } } ] }, { "DurationInMinutes": 5, "Targets": [ { "ChannelTargetInfo": { "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a", "RetryIntervalInMinutes": 1 } } ] } ] } }

Exemple 2 : pour décrire un plan d’escalade

L’exemple get-contact suivant décrit un plan d’escalade.

aws ssm-contacts get-contact \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation"

Sortie :

{ "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", "Alias": "example_escalation", "DisplayName": "Example Escalation", "Type": "ESCALATION", "Plan": { "Stages": [ { "DurationInMinutes": 5, "Targets": [ { "ContactTargetInfo": { "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "IsEssential": true } } ] }, { "DurationInMinutes": 5, "Targets": [ { "ContactTargetInfo": { "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr", "IsEssential": false } } ] }, { "DurationInMinutes": 0, "Targets": [ { "ContactTargetInfo": { "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi", "IsEssential": false } } ] } ] } }

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

  • Pour plus de détails sur l'API, reportez-vous GetContactà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-contact-channels.

AWS CLI

Pour répertorier les canaux de contact d’un contact

L’exemple list-contact-channels suivant répertorie les canaux de contact disponibles du contact spécifié.

aws ssm-contacts list-contact-channels \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"

Sortie :

{ [ { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Name": "akuas email", "Type": "EMAIL", "DeliveryAddress": { "SimpleAddress": "akuam@example.com" }, "ActivationStatus": "NOT_ACTIVATED" }, { "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Name": "akuas sms", "Type": "SMS", "DeliveryAddress": { "SimpleAddress": "+15005550100" }, "ActivationStatus": "ACTIVATED" } ] }

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

  • Pour plus de détails sur l'API, reportez-vous ListContactChannelsà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-contacts.

AWS CLI

Pour répertorier tous les plans d’escalade et les contacts

L’exemple list-contacts suivant répertorie les contacts et les plans d’escalade de votre compte.

aws ssm-contacts list-contacts

Sortie :

{ "Contacts": [ { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Alias": "akuam", "DisplayName": "Akua Mansa", "Type": "PERSONAL" }, { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr", "Alias": "alejr", "DisplayName": "Alejandro Rosalez", "Type": "PERSONAL" }, { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi", "Alias": "anasi", "DisplayName": "Ana Carolina Silva", "Type": "PERSONAL" }, { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", "Alias": "example_escalation", "DisplayName": "Example Escalation", "Type": "ESCALATION" } ] }

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

  • Pour plus de détails sur l'API, reportez-vous ListContactsà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-engagements.

AWS CLI

Pour répertorier tous les engagements

L’exemple list-engagements suivant répertorie les engagements pris dans le cadre de plans d’escalade et de contacts. Vous pouvez également répertorier les engagements d’un seul incident.

aws ssm-contacts list-engagements

Sortie :

{ "Engagements": [ { "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/91792571-0b53-4821-9f73-d25d13d9e529", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Sender": "cli", "StartTime": "2021-05-18T20:37:50.300000+00:00" }, { "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Sender": "cli", "StartTime": "2021-05-18T18:40:26.666000+00:00" }, { "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", "Sender": "cli", "StartTime": "2021-05-18T18:25:41.151000+00:00" }, { "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Sender": "cli", "StartTime": "2021-05-18T18:20:58.093000+00:00" } ] }

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

  • Pour plus de détails sur l'API, reportez-vous ListEngagementsà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-page-receipts.

AWS CLI

Pour répertorier les pages reçues

L’exemple command-name suivant indique si une page a été reçue ou non par un contact.

aws ssm-contacts list-page-receipts \ --page-id "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3"

Sortie :

{ "Receipts": [ { "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", "ReceiptType": "DELIVERED", "ReceiptInfo": "425440", "ReceiptTime": "2021-05-18T20:42:57.485000+00:00" }, { "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", "ReceiptType": "READ", "ReceiptInfo": "425440", "ReceiptTime": "2021-05-18T20:42:57.907000+00:00" }, { "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", "ReceiptType": "SENT", "ReceiptInfo": "SM6656c19132f1465f9c9c1123a5dde7c9", "ReceiptTime": "2021-05-18T20:40:52.962000+00:00" } ] }

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

  • Pour plus de détails sur l'API, reportez-vous ListPageReceiptsà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-pages-by-contact.

AWS CLI

Pour répertorier les pages par contact

L’exemple list-pages-by-contact suivant répertorie toutes les pages du contact spécifié.

aws ssm-contacts list-pages-by-contact \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"

Sortie :

{ "Pages": [ { "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Sender": "cli", "SentTime": "2021-05-18T18:43:29.301000+00:00", "DeliveryTime": "2021-05-18T18:43:55.265000+00:00", "ReadTime": "2021-05-18T18:43:55.708000+00:00" } ] }

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

  • Pour plus de détails sur l'API, reportez-vous ListPagesByContactà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-pages-by-engagement.

AWS CLI

Pour répertorier les pages permettant de contacter les canaux créés à partir d’un engagement

L’exemple list-pages-by-engagement suivant répertorie les pages apparues lors de la mise en œuvre du plan d’engagement défini.

aws ssm-contacts list-pages-by-engagement \ --engagement-id "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0"

Sortie :

{ "Pages": [ { "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Sender": "cli", "SentTime": "2021-05-18T18:40:27.245000+00:00" } ] }

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

  • Pour plus de détails sur l'API, reportez-vous ListPagesByEngagementà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-tags-for-resource.

AWS CLI

Pour répertorier les balises d’un contact

L’exemple list-tags-for-resource suivant répertorie les balises du contact spécifié.

aws ssm-contacts list-tags-for-resource \ --resource-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"

Sortie :

{ "Tags": [ { "Key": "group1", "Value": "1" } ] }

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

  • Pour plus de détails sur l'API, reportez-vous ListTagsForResourceà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserput-contact-policy.

AWS CLI

Pour partager un contact et ses engagements

L’exemple put-contact-policy suivant ajoute une politique de ressources au contact Akua qui partage le contact et les engagements connexes avec le principal.

aws ssm-contacts put-contact-policy \ --contact-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \ --policy "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"ExampleResourcePolicy\",\"Action\":[\"ssm-contacts:GetContact\",\"ssm-contacts:StartEngagement\",\"ssm-contacts:DescribeEngagement\",\"ssm-contacts:ListPagesByEngagement\",\"ssm-contacts:StopEngagement\"],\"Principal\":{\"AWS\":\"222233334444\"},\"Effect\":\"Allow\",\"Resource\":[\"arn:aws:ssm-contacts:*:111122223333:contact\/akuam\",\"arn:aws:ssm-contacts:*:111122223333:engagement\/akuam\/*\"]}]}"

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, reportez-vous PutContactPolicyà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisersend-activation-code.

AWS CLI

Pour envoyer un code d’activation

L’exemple send-activation-code suivant envoie un code d’activation et un message au canal de contact spécifié.

aws ssm-contacts send-activation-code \ --contact-channel-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/8ddae2d1-12c8-4e45-b852-c8587266c400"

Cette commande ne produit aucune sortie.

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

  • Pour plus de détails sur l'API, reportez-vous SendActivationCodeà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserstart-engagement.

AWS CLI

Exemple 1 : pour paginer les canaux de contact d’un contact

L’exemple start-engagement suivant pagine les canaux de contact d’un contact. L’expéditeur, l’objet, public-subject et public-content sont tous des champs libres. Incident Manager envoie l’objet et le contenu aux canaux de contact VOIX ou E-MAIL fournis. Incident Manager envoie public-subject et public-content aux canaux de contact SMS fournis. L’expéditeur est utilisé pour savoir qui a démarré l’engagement.

aws ssm-contacts start-engagement \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" \ --sender "cli" \ --subject "cli-test" \ --content "Testing engagements via CLI" \ --public-subject "cli-test" \ --public-content "Testing engagements va CLI"

Sortie :

{ "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f" }

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

Exemple 2 : pour paginer un contact dans le plan d’escalade fourni

L’exemple start-engagement suivant engage le contact dans le cadre d’un plan d’escalade. Chaque contact est paginé en fonction de son plan d’engagement.

aws ssm-contacts start-engagement \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation" \ --sender "cli" \ --subject "cli-test" \ --content "Testing engagements via CLI" \ --public-subject "cli-test" \ --public-content "Testing engagements va CLI"

Sortie :

{ "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356" }

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

  • Pour plus de détails sur l'API, reportez-vous StartEngagementà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserstop-engagement.

AWS CLI

Pour mettre fin à un engagement

L’exemple stop-engagement suivant empêche un engagement de paginer d’autres contacts et canaux de contact.

aws ssm-contacts stop-engagement \ --engagement-id "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"

Cette commande ne produit aucune sortie.

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

  • Pour plus de détails sur l'API, reportez-vous StopEngagementà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisertag-resource.

AWS CLI

Pour baliser un contact

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

aws ssm-contacts tag-resource \ --resource-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \ --tags '[{"Key":"group1","Value":"1"}]'

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, reportez-vous TagResourceà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliseruntag-resource.

AWS CLI

Pour supprimer des balises d’un contact

L’exemple untag-resource suivant supprime la balise group1 du contact spécifié.

aws ssm-contacts untag-resource \ --resource-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \ --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, reportez-vous UntagResourceà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-contact-channel.

AWS CLI

Pour mettre à jour un canal de contact

L’exemple update-contact-channel suivant met à jour le nom et l’adresse de livraison d’un canal de contact.

aws ssm-contacts update-contact-channel \ --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad" \ --name "akuas voice channel" \ --delivery-address '{"SimpleAddress": "+15005550198"}'

Cette commande ne produit aucune sortie.

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

  • Pour plus de détails sur l'API, reportez-vous UpdateContactChannelà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-contact.

AWS CLI

Pour mettre à jour le plan d’engagement d’un contact

L’exemple update-contact suivant met à jour le plan d’engagement du contact Akua afin d’y inclure les trois types de canaux de contact. Cette opération est possible après la création des canaux de contact d’Akua.

aws ssm-contacts update-contact \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" \ --plan '{"Stages": [{"DurationInMinutes": 5, "Targets": [{"ChannelTargetInfo": {"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65","RetryIntervalInMinutes": 1 }}]}, {"DurationInMinutes": 5, "Targets": [{"ChannelTargetInfo":{"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad", "RetryIntervalInMinutes": 1}}]}, {"DurationInMinutes": 5, "Targets": [{"ChannelTargetInfo": {"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a","RetryIntervalInMinutes": 1 }}]}]}'

Cette commande ne produit aucune sortie.

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

  • Pour plus de détails sur l'API, reportez-vous UpdateContactà la section Référence des AWS CLI commandes.