Esempi di Contatti di Incident Manager che utilizzano la AWS CLI
Negli esempi di codice seguenti viene mostrato come eseguire azioni e implementare scenari comuni utilizzando AWS Command Line Interface con Contatti di Incident Manager.
Le operazioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le operazioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.
Ogni esempio include un link al codice sorgente completo, dove è possibile trovare le istruzioni su come configurare ed eseguire il codice nel contesto.
Argomenti
Operazioni
L’esempio di codice seguente mostra come utilizzare accept-page.
- AWS CLI
-
Come accettare una pagina durante un coinvolgimento
L’esempio
accept-pageseguente 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-typeREAD\ --accept-code425440Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta AcceptPage
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare activate-contact-channel.
- AWS CLI
-
Come attivare il canale di contatto di un contatto
L’esempio
activate-contact-channelseguente 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, consulta Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta ActivateContactChannel
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare command-name.
- AWS CLI
-
Come eliminare un contatto
L’esempio
command-nameseguente 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 Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta CommandName
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare create-contact-channel.
- AWS CLI
-
Come creare un canale di contatto
Crea un canale di contatto di tipo SMS per il contatto Akua Mansa. È possibile creare canali di contatto di tipo SMS, EMAIL o VOICE.
aws ssm-contacts create-contact-channel \ --contact-id"arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"\ --name"akuas sms-test"\ --typeSMS\ --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 Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta CreateContactChannel
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare create-contact.
- AWS CLI
-
Per creare un contatto
L’esempio
create-contactseguente crea un contatto nel tuo ambiente con un piano vuoto. Il piano può essere aggiornato dopo aver creato i canali di contatto. Utilizza il comando create-contact-channel con l’ARN di output di questo comando. Dopo aver creato i canali di contatto per questo contatto, utilizza update-contact per aggiornare il piano.aws ssm-contacts create-contact \ --alias"akuam"\ --display-name"Akua Mansa"\ --typePERSONAL\ --plan '{"Stages": []}'Output:
{ "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" }Per ulteriori informazioni, consulta Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta CreateContact
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare deactivate-contact-channel.
- AWS CLI
-
Come disattivare un canale di contatto
L’esempio
deactivate-contact-channelseguente disattiva un canale di contatto. Quando si disattiva un canale di contatto, il canale non verrà più paginato durante un incidente. Puoi riattivare un canale di contatto in qualsiasi momento utilizzando il comandoactivate-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 Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta DeactivateContactChannel
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare delete-contact-channel.
- AWS CLI
-
Come eliminare un canale di contatto
L’esempio
delete-contact-channelseguente elimina un canale di contatto. Eliminare un canale di contatto assicura che il canale non venga paginato 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 Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta DeleteContactChannel
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare delete-contact.
- AWS CLI
-
Come eliminare un contatto
L’esempio
delete-contactseguente 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 Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta DeleteContact
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare describe-engagement.
- AWS CLI
-
Come descrivere i dettagli di un coinvolgimento
L’esempio
describe-engagementseguente elenca i dettagli di un coinvolgimento relativo a un contatto o a un piano 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 Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta DescribeEngagement
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare describe-page.
- AWS CLI
-
Come elencare i dettagli di una pagina in un canale di contatto
L’esempio
describe-pageseguente elenca i dettagli di una pagina relativa a 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 Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta DescribePage
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare get-contact-channel.
- AWS CLI
-
Come elencare i dettagli di un canale di contatto
L’esempio
get-contact-channelseguente 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, consulta Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta GetContactChannel
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare get-contact-policy.
- AWS CLI
-
Come elencare le policy relative alle risorse di un contatto
L’esempio
get-contact-policyseguente elenca le policy 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, consulta Working with shared contacts and response plans in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta GetContactPolicy
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare get-contact.
- AWS CLI
-
Esempio 1: come descrivere un piano di contatto
L’esempio
get-contactseguente 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: come descrivere un piano di escalation
L’esempio
get-contactseguente 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, consulta Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta GetContact
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare list-contact-channels.
- AWS CLI
-
Come elencare i canali di contatto di un contatto
L’esempio
list-contact-channelsseguente 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, consulta Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta ListContactChannels
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare list-contacts.
- AWS CLI
-
Come elencare tutti i piani di escalation e i contatti
L’esempio
list-contactsseguente elenca i contatti e i piani di escalation presenti nel tuo account.aws ssm-contacts list-contactsOutput:
{ "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 Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta ListContacts
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare list-engagements.
- AWS CLI
-
Come elencare tutti i coinvolgimenti
L’esempio
list-engagementsseguente elenca i coinvolgimenti relativi ai piani di escalation e ai contatti. Puoi anche elencare i coinvolgimenti per un singolo incidente.aws ssm-contacts list-engagementsOutput:
{ "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 Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta ListEngagements
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare list-page-receipts.
- AWS CLI
-
Come elencare le ricevute della pagina
L’esempio
command-nameseguente indica 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, consulta Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta ListPageReceipts
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare list-pages-by-contact.
- AWS CLI
-
Come elencare le pagine per contatto
L’esempio
list-pages-by-contactseguente 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, consulta Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta ListPagesByContact
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare list-pages-by-engagement.
- AWS CLI
-
Come elencare le pagine dei canali di contatto avviate da un coinvolgimento
L’esempio
list-pages-by-engagementseguente elenca le pagine che si sono verificate durante l’interazione con il 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, consulta Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta ListPagesByEngagement
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare list-tags-for-resource.
- AWS CLI
-
Come elencare i tag di un contatto
L’esempio
list-tags-for-resourceseguente 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, consulta Tagging in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta ListTagsForResource
in Riferimento ai comandi AWS CLI.
-
L’esempio di codice seguente mostra come utilizzare put-contact-policy.
- AWS CLI
-
Come condividere un contatto e i coinvolgimenti
L’esempio
put-contact-policyseguente aggiunge una policy sulle risorse al contatto Akua che condivide il contatto e i coinvolgimenti 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, consulta Working with shared contacts and response plans in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta PutContactPolicy
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare send-activation-code.
- AWS CLI
-
Come inviare un codice di attivazione
L’esempio
send-activation-codeseguente 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, consulta Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta SendActivationCode
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare start-engagement.
- AWS CLI
-
Esempio 1: come eseguire la paginazione dei canali di contatto di un contatto
Il comando
start-engagementseguente esegue la paginazione dei canali di contatto del contatto. Sender, subject, public-subject e public-content sono tutti campi privi di valori. Incident Manager invia l’oggetto e il contenuto ai canali di contatto VOICE o EMAIL forniti. Incident Manager invia public-subject e public-content ai canali di contatto SMS forniti. 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 Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
Esempio 2: come eseguire il paging di un contatto nel piano di escalation fornito.
Il comando
start-engagementseguente coinvolge i contatti attraverso un piano di escalation. Ogni contatto viene paginato 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 Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta StartEngagement
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare stop-engagement.
- AWS CLI
-
Come arrestare un coinvolgimento
L’esempio
stop-engagementseguente 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 Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta StopEngagement
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare tag-resource.
- AWS CLI
-
Come applicare tag a un contatto
L’esempio
tag-resourceseguente contrassegna un contatto specificato con la coppia chiave di tag-valore 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, consulta Tagging in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta TagResource
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare untag-resource.
- AWS CLI
-
Come rimuovere i tag da un contatto
L’esempio
untag-resourceseguente 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, consulta Tagging in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta UntagResource
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare update-contact-channel.
- AWS CLI
-
Come aggiornare un canale di contatto
L’esempio
update-contact-channelseguente 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, consulta Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta UpdateContactChannel
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare update-contact.
- AWS CLI
-
Come aggiornare il piano di coinvolgimento dei contatti
L’esempio
update-contactseguente aggiorna il piano di coinvolgimento del contatto Akua per includere i tre tipi di canali di contatto. Questa operazione viene eseguita dopo la creazione dei 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 Contacts in Guida per l’utente di Strumento di gestione degli incidenti.
-
Per informazioni dettagliate sull’API, consulta UpdateContact
in AWS CLI Command Reference.
-