Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
Beispiele für Incident Manager-Kontakte mit AWS CLI
Die folgenden Codebeispiele zeigen Ihnen, wie Sie AWS Command Line Interface mit Incident Manager-Kontakten Aktionen ausführen und allgemeine Szenarien implementieren.
Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Service-Funktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarien anzeigen.
Jedes Beispiel enthält einen Link zum vollständigen Quellcode, wo Sie Anweisungen zum Einrichten und Ausführen des Codes im Kodex finden.
Themen
Aktionen
Das folgende Codebeispiel zeigt, wie Sieaccept-page.
- AWS CLI
-
So akzeptieren Sie eine Seite während einer Interaktion
Im folgenden Beispiel für
accept-pagewird ein Akzeptanzcode verwendet, der an den Kontaktkanal gesendet wird, um eine Seite zu akzeptieren.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-code425440Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie AcceptPage
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungactivate-contact-channel.
- AWS CLI
-
So aktivieren Sie den Kontaktkanal eines Kontakts
Im folgenden Beispiel für
activate-contact-channelwird ein Kontaktkanal aktiviert und macht ihn als Teil eines Vorfalls nutzbar.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"Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie ActivateContactChannel
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungcommand-name.
- AWS CLI
-
Um einen Kontakt zu löschen
Im folgenden Beispiel für
command-namewird ein Kontakt gelöscht. Der Kontakt wird über keinen Eskalationsplan, der sich auf ihn bezieht, mehr erreichbar sein.aws ssm-contacts delete-contact \ --contact-id"arn:aws:ssm-contacts:us-east-1:682428703967:contact/alejr"Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie CommandName
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungcreate-contact-channel.
- AWS CLI
-
So erstellen Sie einen Kontaktkanal
Es wird ein Kontaktkanal vom Typ SMS für den Kontakt Akua Mansa erstellt. Kontaktkanäle können vom Typ SMS, EMAIL oder VOICE erstellt werden.
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"}'Ausgabe:
{ "ContactChannelArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/02f506b9-ea5d-4764-af89-2daa793ff024" }Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie CreateContactChannel
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungcreate-contact.
- AWS CLI
-
Um einen Kontakt zu erstellen
Im folgenden Beispiel für
create-contactwird ein Kontakt in Ihrer Umgebung mit einem leeren Plan erstellt. Der Plan kann nach dem Erstellen von Kontaktkanälen aktualisiert werden. Verwenden Sie den create-contact-channel Befehl mit dem Ausgabe-ARN dieses Befehls. Nachdem Sie Kontaktkanäle für diesen Kontakt erstellt haben, verwenden Sie update-contact, um den Plan zu aktualisieren.aws ssm-contacts create-contact \ --alias"akuam"\ --display-name"Akua Mansa"\ --typePERSONAL\ --plan '{"Stages": []}'Ausgabe:
{ "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" }Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie CreateContact
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungdeactivate-contact-channel.
- AWS CLI
-
So deaktivieren Sie einen Kontaktkanal
Im folgenden Beispiel für
deactivate-contact-channelwird ein Kontaktkanal deaktiviert. Die Deaktivierung eines Kontaktkanals bedeutet, dass der Kontaktkanal während eines Vorfalls nicht mehr per Paging verbunden wird. Sie können einen Kontaktkanal auch jederzeit mit dem Befehlactivate-contact-channelreaktivieren.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"Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie DeactivateContactChannel
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungdelete-contact-channel.
- AWS CLI
-
So löschen Sie einen Kontaktkanal
Im folgenden Beispiel für
delete-contact-channelwird ein Kontaktkanal gelöscht. Durch das Löschen eines Kontaktkanals wird sichergestellt, dass der Kontaktkanal während eines Vorfalls nicht per Paging verbunden wird.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"Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie DeleteContactChannel
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungdelete-contact.
- AWS CLI
-
Um einen Kontakt zu löschen
Im folgenden Beispiel für
delete-contactwird ein Kontakt gelöscht. Der Kontakt wird über keinen Eskalationsplan, der sich auf ihn bezieht, mehr erreichbar sein.aws ssm-contacts delete-contact \ --contact-id"arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr"Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie DeleteContact
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungdescribe-engagement.
- AWS CLI
-
So beschreiben Sie die Einzelheiten einer Interaktion
Im folgenden Beispiel für
describe-engagementwerden die Details einer Interaktion mit einem Kontakt oder Eskalationsplan aufgelistet. Der Betreff und der Inhalt werden an die Kontaktkanäle gesendet.aws ssm-contacts describe-engagement \ --engagement-id"arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"Ausgabe:
{ "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" }Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie DescribeEngagement
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungdescribe-page.
- AWS CLI
-
So listen Sie die Details einer Seite für einen Kontaktkanal auf
Im folgenden Beispiel für
describe-pagewerden die Details einer Seite für einen Kontaktkanal aufgelistet. Die Seite wird den Betreff und den bereitgestellten Inhalt enthalten.aws ssm-contacts describe-page \ --page-id"arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93"Ausgabe:
{ "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" }Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie DescribePage
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungget-contact-channel.
- AWS CLI
-
So listen Sie die Details eines Kontaktkanals auf
Im folgenden Beispiel für
get-contact-channelwerden die Details eines Kontaktkanals aufgelistet.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"Ausgabe:
{ "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" }Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie GetContactChannel
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungget-contact-policy.
- AWS CLI
-
So listen Sie die Ressourcenrichtlinien eines Kontakts auf
Im folgenden Beispiel für
get-contact-policywerden die Ressourcenrichtlinien aufgelistet, die dem angegebenen Kontakt zugeordnet sind.aws ssm-contacts get-contact-policy \ --contact-arn"arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"Ausgabe:
{ "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/*\"]}]}" }Weitere Informationen finden Sie unter Arbeiten mit freigegebenen Kontakten und Reaktionsplänen im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie GetContactPolicy
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungget-contact.
- AWS CLI
-
Beispiel 1: So beschreiben Sie einen Kontaktplan
Im folgenden Beispiel für
get-contactwird ein Kontakt beschrieben.aws ssm-contacts get-contact \ --contact-id"arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"Ausgabe:
{ "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 } } ] } ] } }Beispiel 2: So beschreiben Sie einen Eskalationsplan
Im folgenden Beispiel für
get-contactwird ein Eskalationsplan beschrieben.aws ssm-contacts get-contact \ --contact-id"arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation"Ausgabe:
{ "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 } } ] } ] } }Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie GetContact
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendunglist-contact-channels.
- AWS CLI
-
So listen Sie die Kontaktkanäle eines Kontakts auf
Im folgenden Beispiel für
list-contact-channelswerden die verfügbaren Kontaktkanäle des angegebenen Kontakts aufgelistet.aws ssm-contacts list-contact-channels \ --contact-id"arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"Ausgabe:
{ [ { "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" } ] }Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie ListContactChannels
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendunglist-contacts.
- AWS CLI
-
So listen Sie alle Eskalationspläne und Kontakte auf
Im folgenden Beispiel für
list-contactswerden die Kontakte und Eskalationspläne in Ihrem Konto aufgelistet.aws ssm-contacts list-contactsAusgabe:
{ "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" } ] }Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie ListContacts
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendunglist-engagements.
- AWS CLI
-
So listen Sie alle Interaktionen auf
Im folgenden Beispiel für
list-engagementswerden Interaktionen mit Eskalationsplänen und Kontakten aufgelistet. Sie können auch Interaktionen für einen einzelnen Vorfall auflisten.aws ssm-contacts list-engagementsAusgabe:
{ "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" } ] }Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie ListEngagements
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendunglist-page-receipts.
- AWS CLI
-
So listen Sie Seitenbelege auf
Im folgenden Beispiel für
command-namewird aufgeführt, ob eine Seite von einem Kontakt empfangen wurde oder nicht.aws ssm-contacts list-page-receipts \ --page-id"arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3"Ausgabe:
{ "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" } ] }Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie ListPageReceipts
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendunglist-pages-by-contact.
- AWS CLI
-
So listen Sie Seiten nach Kontakt auf
Im folgenden Beispiel für
list-pages-by-contactwerden alle Seiten für den angegebenen Kontakt aufgelistet.aws ssm-contacts list-pages-by-contact \ --contact-id"arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"Ausgabe:
{ "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" } ] }Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie ListPagesByContact
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendunglist-pages-by-engagement.
- AWS CLI
-
So listen Sie Seiten von Kontaktkanälen auf, die mit einer Interaktion gestartet wurden.
Im folgenden Beispiel für
list-pages-by-engagementwerden die Seiten aufgelistet, die während der Interaktion mit dem definierten Engagement-Plan entstanden sind.aws ssm-contacts list-pages-by-engagement \ --engagement-id"arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0"Ausgabe:
{ "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" } ] }Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie ListPagesByEngagement
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendunglist-tags-for-resource.
- AWS CLI
-
So listen Sie die Tags für einen Kontakt auf
Im folgenden Beispiel für
list-tags-for-resourcewerden die Tags des angegebenen Kontakts aufgelistet.aws ssm-contacts list-tags-for-resource \ --resource-arn"arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"Ausgabe:
{ "Tags": [ { "Key": "group1", "Value": "1" } ] }Weitere Informationen finden Sie unter Markieren im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie ListTagsForResource
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungput-contact-policy.
- AWS CLI
-
So teilen Sie einen Kontakt und Interaktionen
Im folgenden Beispiel für
put-contact-policywird dem Kontakt Akua eine Ressourcenrichtlinie hinzugefügt, die den Kontakt und die damit verbundenen Interaktionen mit dem Prinzipal teilt.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\/*\"]}]}"Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Arbeiten mit freigegebenen Kontakten und Reaktionsplänen im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie PutContactPolicy
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungsend-activation-code.
- AWS CLI
-
So senden Sie einen Aktivierungscode
Im folgenden Beispiel für
send-activation-codewird ein Aktivierungscode und eine Nachricht an den angegebenen Kontaktkanal gesendet.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"Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie SendActivationCode
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungstart-engagement.
- AWS CLI
-
Beispiel 1: So finden Sie die Kontaktkanäle eines Kontakts
Die folgenden
start-engagement-Seiten finden die Kontaktkanäle eines Kontakts. Absender, Betreff, öffentlicher Betreff und öffentlicher Inhalt sind alle frei von Feldern. Incident Manager sendet den Betreff und den Inhalt an die bereitgestellten VOICE- oder E-MAIL-Kontaktkanäle. Incident Manager sendet den öffentlichen Betreff und die öffentlichen Inhalte an die bereitgestellten SMS-Kontaktkanäle. Absender wird verwendet, um nachzuverfolgen, wer die Interaktion gestartet hat.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"Ausgabe:
{ "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f" }Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
Beispiel 2: So platzieren Sie einen Kontakt im bereitgestellten Eskalationsplan.
Im folgenden Beispiel für
start-engagementwerden die Kontakte über einen Eskalationsplan eingebunden. Jeder Kontakt wird entsprechend seinem Interaktionsplan gefunden.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"Ausgabe:
{ "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356" }Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie StartEngagement
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungstop-engagement.
- AWS CLI
-
So beenden Sie eine Interaktion
Im folgenden Beispiel für
stop-engagementwird verhindert, dass eine Interaktion weitere Kontakte und Kontaktkanäle findet.aws ssm-contacts stop-engagement \ --engagement-id"arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie StopEngagement
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungtag-resource.
- AWS CLI
-
So markieren Sie einen Kontakt
Im folgenden Beispiel für
tag-resourcewird ein angegebener Kontakt mit dem angegebenen Tag-Schlüssel-Wert-Paar markiert.aws ssm-contacts tag-resource \ --resource-arn"arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"\ --tags '[{"Key":"group1","Value":"1"}]'Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Markieren im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie TagResource
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendunguntag-resource.
- AWS CLI
-
So entfernen Sie Tags aus einem Kontakt
Im folgenden Beispiel für
untag-resourcewird das group1-Tag von dem angegebenen Kontakt entfernt.aws ssm-contacts untag-resource \ --resource-arn"arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"\ --tag-keys"group1"Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Markieren im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie UntagResource
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungupdate-contact-channel.
- AWS CLI
-
So aktualisieren Sie einen Kontaktkanal
Im folgenden Beispiel für
update-contact-channelwird der Name und die Lieferadresse eines Kontaktkanals aktualisiert.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"}'Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie UpdateContactChannel
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungupdate-contact.
- AWS CLI
-
So aktualisieren Sie den Interaktionsplan für den Kontakt
Im folgenden Beispiel für
update-contactwird der Interaktionsplan des Kontakts Akua aktualisiert, sodass er die drei Arten von Kontaktkanälen umfasst. Dies erfolgt nach der Erstellung von Kontaktkanälen für 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 }}]}]}'Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Kontakte im Benutzerhandbuch für Incident Manager.
-
Einzelheiten zur API finden Sie UpdateContact
in der AWS CLI Befehlsreferenz.
-