Esempi di contatti di Incident Manager utilizzando AWS CLI - AWS Command Line Interface

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Esempi di contatti di Incident Manager utilizzando AWS CLI

I seguenti esempi di codice mostrano come eseguire azioni e implementare scenari comuni utilizzando AWS Command Line Interface with Incident Manager Contacts.

Le operazioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le azioni mostrino come richiamare le singole funzioni di servizio, è possibile visualizzare le azioni nel contesto degli scenari correlati.

Ogni esempio include un collegamento al codice sorgente completo, in cui è possibile trovare istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Azioni

Il seguente esempio di codice mostra come utilizzareaccept-page.

AWS CLI

Accettare una pagina durante un coinvolgimento

L'accept-pageesempio seguente utilizza un codice di accettazione inviato al canale di contatto per accettare una pagina.

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

Questo comando non produce alcun output

Per ulteriori informazioni, vedere Contatti nella Guida per l'utente di Incident Manager.

  • Per API i dettagli, vedere AcceptPagein AWS CLI Command Reference.

Il seguente esempio di codice mostra come utilizzareactivate-contact-channel.

AWS CLI

Attiva il canale di contatto di un contatto

L'activate-contact-channelesempio seguente attiva un canale di contatto e lo rende utilizzabile come parte di un incidente.

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"

Questo comando non produce alcun output.

Per ulteriori informazioni, vedere Contatti nella Guida per l'utente di Incident Manager.

Il seguente esempio di codice mostra come utilizzarecommand-name.

AWS CLI

Per eliminare un contatto

L'command-nameesempio seguente elimina un contatto. Il contatto non sarà più raggiungibile da nessun piano di escalation che lo riguardi.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Contatti nella Guida per l'utente di Incident Manager.

  • Per API i dettagli, vedere CommandNamein AWS CLI Command Reference.

Il seguente esempio di codice mostra come utilizzarecreate-contact-channel.

AWS CLI

Per creare un canale di contatto

Crea un canale di contatto di tipo SMS per il contatto Akua Mansa. I canali di contatto possono essere creati di tipo SMSEMAIL, o. VOICE

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

Output:

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

Per ulteriori informazioni, consulta Contatti nella Guida per l'utente di Incident Manager.

Il seguente esempio di codice mostra come utilizzarecreate-contact.

AWS CLI

Per creare un contatto

L'create-contactesempio seguente crea un contatto nell'ambiente in uso con un piano vuoto. Il piano può essere aggiornato dopo aver creato i canali di contatto. Usa il create-contact-channel comando con l'output ARN di questo comando. Dopo aver creato i canali di contatto per questo contatto, usa update-contact per aggiornare il piano.

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

Output:

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

Per ulteriori informazioni, consulta Contatti nella Guida per l'utente di Incident Manager.

  • Per API i dettagli, vedere CreateContactin AWS CLI Command Reference.

Il seguente esempio di codice mostra come utilizzaredeactivate-contact-channel.

AWS CLI

Per disattivare un canale di contatto

L'deactivate-contact-channelesempio seguente disattiva un canale di contatto. La disattivazione di un canale di contatto significa che il canale di contatto non verrà più contattato durante un incidente. Puoi anche riattivare un canale di contatto in qualsiasi momento utilizzando il comando. 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"

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Contatti nella Guida per l'utente di Incident Manager.

Il seguente esempio di codice mostra come utilizzaredelete-contact-channel.

AWS CLI

Per eliminare un canale di contatto

L'delete-contact-channelesempio seguente elimina un canale di contatto. L'eliminazione di un canale di contatto garantisce che il canale di contatto non venga contattato durante un incidente.

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"

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Contatti nella Guida per l'utente di Incident Manager.

Il seguente esempio di codice mostra come utilizzaredelete-contact.

AWS CLI

Per eliminare un contatto

L'delete-contactesempio seguente elimina un contatto. Il contatto non sarà più raggiungibile da nessun piano di escalation che lo riguardi.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Contatti nella Guida per l'utente di Incident Manager.

  • Per API i dettagli, vedere DeleteContactin AWS CLI Command Reference.

Il seguente esempio di codice mostra come utilizzaredescribe-engagement.

AWS CLI

Descrivere i dettagli di un impegno

L'describe-engagementesempio seguente elenca i dettagli di un coinvolgimento in un piano di contatto o di escalation. L'oggetto e il contenuto vengono inviati ai canali di contatto.

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

Output:

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

Per ulteriori informazioni, consulta Contatti nella Guida per l'utente di Incident Manager.

Il seguente esempio di codice mostra come utilizzaredescribe-page.

AWS CLI

Per elencare i dettagli di una pagina in un canale di contatto

L'describe-pageesempio seguente elenca i dettagli di una pagina in un canale di contatto. La pagina includerà l'oggetto e il contenuto forniti.

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

Output:

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

Per ulteriori informazioni, consulta Contatti nella Guida per l'utente di Incident Manager.

  • Per API i dettagli, vedere DescribePagein AWS CLI Command Reference.

Il seguente esempio di codice mostra come utilizzareget-contact-channel.

AWS CLI

Per elencare i dettagli di un canale di contatto

L'get-contact-channelesempio seguente elenca i dettagli di un canale di contatto.

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"

Output:

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

Per ulteriori informazioni, vedere Contatti nella Guida per l'utente di Incident Manager.

Il seguente esempio di codice mostra come utilizzareget-contact-policy.

AWS CLI

Per elencare le politiche relative alle risorse di un contatto

L'get-contact-policyesempio seguente elenca le politiche relative alle risorse associate al contatto specificato.

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

Output:

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

Per ulteriori informazioni, vedere Utilizzo dei contatti condivisi e dei piani di risposta nella Guida per l'utente di Incident Manager.

Il seguente esempio di codice mostra come utilizzareget-contact.

AWS CLI

Esempio 1: Per descrivere un piano di contatto

L'get-contactesempio seguente descrive un contatto.

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

Output:

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

Esempio 2: descrivere un piano di escalation

L'get-contactesempio seguente descrive un piano di escalation.

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

Output:

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

Per ulteriori informazioni, vedere Contatti nella Guida per l'utente di Incident Manager.

  • Per API i dettagli, vedere GetContactin AWS CLI Command Reference.

Il seguente esempio di codice mostra come utilizzarelist-contact-channels.

AWS CLI

Per elencare i canali di contatto di un contatto

L'list-contact-channelsesempio seguente elenca i canali di contatto disponibili del contatto specificato.

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

Output:

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

Per ulteriori informazioni, vedere Contatti nella Guida per l'utente di Incident Manager.

Il seguente esempio di codice mostra come utilizzarelist-contacts.

AWS CLI

Per elencare tutti i piani di escalation e i contatti

L'list-contactsesempio seguente elenca i contatti e i piani di escalation presenti nel tuo account.

aws ssm-contacts list-contacts

Output:

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

Per ulteriori informazioni, consulta Contatti nella Guida per l'utente di Incident Manager.

  • Per API i dettagli, vedere ListContactsin AWS CLI Command Reference.

Il seguente esempio di codice mostra come utilizzarelist-engagements.

AWS CLI

Per elencare tutti gli impegni

L'list-engagementsesempio seguente elenca gli impegni relativi ai piani di escalation e ai contatti. È inoltre possibile elencare gli impegni per un singolo incidente.

aws ssm-contacts list-engagements

Output:

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

Per ulteriori informazioni, consulta Contatti nella Guida per l'utente di Incident Manager.

Il seguente esempio di codice mostra come utilizzarelist-page-receipts.

AWS CLI

Per elencare le ricevute della pagina

L'command-nameesempio seguente elenca se una pagina è stata ricevuta o meno da un contatto.

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

Output:

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

Per ulteriori informazioni, vedere Contatti nella Guida per l'utente di Incident Manager.

Il seguente esempio di codice mostra come utilizzarelist-pages-by-contact.

AWS CLI

Per elencare le pagine per contatto

L'list-pages-by-contactesempio seguente elenca tutte le pagine relative al contatto specificato.

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

Output:

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

Per ulteriori informazioni, vedere Contatti nella Guida per l'utente di Incident Manager.

Il seguente esempio di codice mostra come utilizzarelist-pages-by-engagement.

AWS CLI

Elencare le pagine dei canali di contatto partendo da un engagement.

L'list-pages-by-engagementesempio seguente elenca le pagine che si sono verificate durante l'implementazione del piano di coinvolgimento definito.

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

Output:

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

Per ulteriori informazioni, vedere Contatti nella Guida per l'utente di Incident Manager.

Il seguente esempio di codice mostra come utilizzarelist-tags-for-resource.

AWS CLI

Per elencare i tag di un contatto

L'list-tags-for-resourceesempio seguente elenca i tag del contatto specificato.

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

Output:

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

Per ulteriori informazioni, vedere Tagging nella Guida per l'utente di Incident Manager.

Il seguente esempio di codice mostra come utilizzareput-contact-policy.

AWS CLI

Per condividere un contatto e gli impegni

L'put-contact-policyesempio seguente aggiunge una politica sulle risorse al contatto Akua che condivide il contatto e gli impegni correlati con il principale.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, vedere Utilizzo dei contatti condivisi e dei piani di risposta nella Guida per l'utente di Incident Manager.

Il seguente esempio di codice mostra come utilizzaresend-activation-code.

AWS CLI

Per inviare un codice di attivazione

L'send-activation-codeesempio seguente invia un codice di attivazione e un messaggio al canale di contatto specificato.

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"

Questo comando non produce alcun output.

Per ulteriori informazioni, vedere Contatti nella Guida per l'utente di Incident Manager.

Il seguente esempio di codice mostra come utilizzarestart-engagement.

AWS CLI

Esempio 1: Paginare i canali di contatto di un contatto

Le start-engagement pagine seguenti: canali di contatto per i contatti. Il mittente, l'oggetto, l'oggetto pubblico e il contenuto pubblico sono tutti privi di campi. Incident Manager invia l'oggetto e il contenuto ai canali forniti o di contatto. VOICE EMAIL Incident Manager invia l'argomento pubblico e il contenuto pubblico ai canali di contatto forniti. SMS Il mittente viene utilizzato per tenere traccia di chi ha avviato il coinvolgimento.

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"

Output:

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

Per ulteriori informazioni, consulta Contatti nella Guida per l'utente di Incident Manager.

Esempio 2: inserire un contatto nel piano di escalation fornito.

Quanto segue start-engagement coinvolge i contatti attraverso un piano di escalation. Ogni contatto viene suddiviso in base al proprio piano di coinvolgimento.

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"

Output:

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

Per ulteriori informazioni, consulta Contatti nella Guida per l'utente di Incident Manager.

Il seguente esempio di codice mostra come utilizzarestop-engagement.

AWS CLI

Interrompere un fidanzamento

L'stop-engagementesempio seguente impedisce a un coinvolgimento di cercare ulteriori contatti e canali di contatto.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Contatti nella Guida per l'utente di Incident Manager.

  • Per API i dettagli, vedere StopEngagementin AWS CLI Command Reference.

Il seguente esempio di codice mostra come utilizzaretag-resource.

AWS CLI

Per taggare un contatto

L'tag-resourceesempio seguente contrassegna un contatto specificato con la coppia chiave-valore del tag fornita.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, vedere Tagging nella Guida per l'utente di Incident Manager.

  • Per API i dettagli, vedere TagResourcein AWS CLI Command Reference.

Il seguente esempio di codice mostra come utilizzareuntag-resource.

AWS CLI

Per rimuovere i tag da un contatto

L'untag-resourceesempio seguente rimuove il tag group1 dal contatto specificato.

aws ssm-contacts untag-resource \ --resource-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \ --tag-keys "group1"

Questo comando non produce alcun output.

Per ulteriori informazioni, vedere Tagging nella Guida per l'utente di Incident Manager.

  • Per API i dettagli, vedere UntagResourcein AWS CLI Command Reference.

Il seguente esempio di codice mostra come utilizzareupdate-contact-channel.

AWS CLI

Per aggiornare un canale di contatto

L'update-contact-channelesempio seguente aggiorna il nome e l'indirizzo di consegna di un canale di contatto.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, vedere Contatti nella Guida per l'utente di Incident Manager.

Il seguente esempio di codice mostra come utilizzareupdate-contact.

AWS CLI

Per aggiornare il piano di coinvolgimento dei contatti

L'update-contactesempio seguente aggiorna il piano di coinvolgimento del contatto Akua per includere i tre tipi di canali di contatto. Questa operazione viene eseguita dopo aver creato i canali di contatto per 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 }}]}]}'

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Contatti nella Guida per l'utente di Incident Manager.

  • Per API i dettagli, vedere UpdateContactin AWS CLI Command Reference.