View a markdown version of this page

AWSSupport-CollectAmazonConnectContactFlowLog - AWS Systems Manager Runbook-Referenz für Automation

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.

AWSSupport-CollectAmazonConnectContactFlowLog

Beschreibung

Das AWSSupport-CollectAmazonConnectContactFlowLog Automatisierungs-Runbook wird verwendet, um die Kontaktflussprotokolle von Connect Customer für eine bestimmte Kontakt-ID zu sammeln. Durch Angabe Ihrer Connect Customer-Instance-ID und Kontakt-ID durchsucht das Runbook die Kontaktflussprotokolle nach dem Kontakt aus der CloudWatch Amazon-Protokollgruppe und lädt sie in den Amazon Simple Storage Service (Amazon S3) -Bucket hoch, der im Anforderungsparameter angegeben ist. Das Runbook generiert eine Ausgabe, die die Amazon S3-Konsolen-URL und den AWS CLI-Befehl bereitstellt, damit Sie die Protokolle herunterladen können.

Wie funktioniert es?

Das AWSSupport-CollectAmazonConnectContactFlowLog Automatisierungs-Runbook hilft dabei, die Kontaktflussprotokolle von Connect Customer für eine bestimmte Kontakt-ID zu sammeln, die in der konfigurierten CloudWatch Protokollgruppe gespeichert ist, und sie in einen bestimmten Amazon S3-Bucket hochzuladen. Um die Sicherheit der aus Ihrem Connect-Kundenkontaktfluss gesammelten Protokolle zu gewährleisten, wertet die Automatisierung die Amazon S3-Bucket-Konfiguration aus, um festzustellen, ob der Bucket öffentliche read oder write Zugriffsberechtigungen gewährt und dem im Parameter angegebenen AWS Konto gehört. S3BucketOwnerAccountId Wenn Ihr Amazon S3-Bucket serverseitige Verschlüsselung mit AWS Key Management Service Schlüsseln (SSE-KMS) verwendet, stellen Sie sicher, dass der Benutzer oder die AWS Identity and Access Management (IAM) -Rolle, die diese Automatisierung ausführt, über die kms:GenerateDataKey Berechtigungen für den Schlüssel verfügt. AWS KMS Weitere Informationen zu den von Ihrer Connect Customer-Instance generierten Logs finden Sie unter In einer CloudWatch Amazon-Protokollgruppe gespeicherte Flow-Protokolle.

Wichtig

Für die CloudWatch Logs Insights-Abfragen fallen Gebühren an, die auf der Menge der abgefragten Daten basieren. Kunden, die über ein kostenloses Kontingent verfügen, wird lediglich die Nutzung berechnet, die die Service-Kontingente überschreitet. Weitere Informationen finden Sie unter Amazon CloudWatch – Preise.

Führen Sie diese Automatisierung aus (Konsole)

Art des Dokuments

Automatisierung

Eigentümer

Amazon

Plattformen

LinuxmacOS, Windows

Parameter

Erforderliche IAM-Berechtigungen

Der AutomationAssumeRole Parameter erfordert die folgenden Aktionen, um das Runbook erfolgreich zu verwenden.

{ "Statement": [ { "Action": [ "s3:GetBucketPublicAccessBlock", "s3:GetBucketPolicyStatus", "s3:GetBucketAcl", "s3:GetObject", "s3:GetObjectAttributes", "s3:PutObject", "s3:PutObjectAcl" ], "Resource": [ "arn:aws:s3:::amzn-s3-demo-bucket/*", "arn:aws:s3:::amzn-s3-demo-bucket" ], "Effect": "Allow" }, { "Action": [ "connect:DescribeInstance", "connect:DescribeContact", "ds:DescribeDirectories" ], "Resource": "*", "Effect": "Allow" }, { "Action": [ "logs:StartQuery", "logs:GetQueryResults" "Resource": "*", "Effect": "Allow" } ] }

Anweisungen

Folgen Sie diesen Schritten, um die Automatisierung zu konfigurieren:

  1. Navigieren Sie AWSSupport-CollectAmazonConnectContactFlowLog im Systems Manager unter Dokumente zu.

  2. Wählen Sie Execute automation (Automatisierung ausführen).

  3. Geben Sie für die Eingabeparameter Folgendes ein:

    • AutomationAssumeRole (Fakultativ):

      Der Amazon-Ressourcenname (ARN) der AWS Identity and Access Management (IAM) -Rolle, die es Systems Manager Automation ermöglicht, die Aktionen in Ihrem Namen durchzuführen. Wenn keine Rolle angegeben ist, verwendet Systems Manager Automation die Berechtigungen des Benutzers, der dieses Runbook startet.

    • ConnectInstanceId (Erforderlich):

      Die ID Ihrer Connect Customer-Instanz.

    • ContactId (Erforderlich):

      Die ID des Kontakts, für den Sie das Kontaktflussprotokoll erfassen möchten.

    • S3BucketName (Erforderlich):

      Der Amazon S3-Bucket-Name in Ihrem Konto, in das Sie das Kontaktflussprotokoll hochladen möchten. Stellen Sie sicher, dass die Bucket-Richtlinie Parteien, die keinen Zugriff auf die gesammelten Protokolle benötigen, keine unnötigen read/write Berechtigungen gewährt.

    • S3ObjectPrefix (Fakultativ):

      Der Amazon S3-Objektpfad im Amazon S3-Bucket für ein hochgeladenes Kontaktflussprotokoll. Wenn Sie beispielsweise angebenCollectedLogs, wird das Protokoll als hochgeladens3://your-s3-bucket/CollectedLogs/ContactFlowLog_[ContactId][AWSAccountId].gz. Wenn Sie diesen Parameter nicht angeben, wird die Ausführungs-ID von Systems Manager Automation verwendet, zum Beispiel:s3://your-s3-bucket/[automation:EXECUTION_ID]/ContactFlowLog[ContactId]_[AWSAccountId].gz. Hinweis: Wenn Sie einen Wert für diese Automatisierung angeben S3ObjectPrefix und diese Automatisierung mit demselben [ContactId] ausführen, wird das Kontaktflussprotokoll überschrieben.

    • S3BucketOwnerAccount (Fakultativ):

      Die AWS Kontonummer, der der Amazon S3-Bucket gehört, in den Sie das Kontaktflussprotokoll hochladen möchten. Wenn Sie diesen Parameter nicht angeben, verwendet das Runbook die AWS Konto-ID des Benutzers oder der Rolle, in der die Automatisierung ausgeführt wird.

    • S3BucketOwnerRoleArn (Fakultativ):

      Der ARN der IAM-Rolle mit den Berechtigungen zum Abrufen der Einstellungen für den öffentlichen Zugriff auf den Amazon S3-Bucket und die Kontosperre, zur Bucket-Verschlüsselungskonfiguration, Bucket-ACLs, zum Bucket-Richtlinienstatus und zum Hochladen von Objekten in den Bucket. Wenn dieser Parameter nicht angegeben ist, verwendet das Runbook den AutomationAssumeRole (falls angegeben) oder den Benutzer, der dieses Runbook startet (falls AutomationAssumeRole nicht angegeben). Weitere Informationen finden Sie im Abschnitt „Erforderliche Berechtigungen“ in der Runbook-Beschreibung.

    Eingabeparameterformular für die AWS Systems Manager Automatisierung mit Feldern für Rollen, IDs und S3-Einstellungen.
  4. Wählen Sie Ausführen aus.

  5. Die Automatisierung wird initiiert.

  6. Das Dokument führt die folgenden Schritte aus:

    • CheckConnectInstanceExistance

      Überprüft, ob die in der bereitgestellte Connect Customer-Instanz vorhanden ConnectInstanceId istACTIVE.

    • CheckS3BucketPublicStatus

      Prüft, ob der im angegebene Amazon S3-Bucket anonyme oder öffentliche Lese- oder Schreibzugriffsberechtigungen S3BucketName zulässt.

    • GenerateLogSearchTimeRange

      Generiert StartTime und EndTime für den StartQuery Schritt, der auf der API basiert InitiationTimestamp und von der DescribeContact API LastUpdateTimestamp zurückgegeben wird. StartTimewird eine Stunde vorher EndTime sein InitiationTimestamp und eine Stunde danach seinLastUpdateTimestamp.

    • StartQuery

      Startet ein Abfrageprotokoll für die ContactId in den CloudWatch Protokollen angegebene Protokollgruppe, die der in Connect Customer bereitgestellten Instanz zugeordnet istConnectInstanceId. Abfragen laufen nach 60 Minuten Laufzeit ab. Wenn bei Ihrer Abfrage ein Timeout auftritt, reduzieren Sie den Zeitraum, in dem gesucht wird. Sie können die aktuell ausgeführten Abfragen sowie Ihren letzten Abfrageverlauf in der CloudWatch Konsole einsehen. Weitere Informationen finden Sie unter Anzeigen laufender Abfragen oder des Abfrageverlaufs.

    • WaitForQueryCompletion

      Wartet darauf, dass das CloudWatch Logs-Abfrageprotokoll abgeschlossen ist, ContactId bis der angegebene Vorgang abgeschlossen ist. Beachten Sie, dass bei der Abfrage nach 60 Minuten Laufzeit ein Timeout auftritt. Wenn bei Ihrer Abfrage ein Timeout auftritt, reduzieren Sie den durchsuchten Zeitraum. Sie können die aktuell ausgeführten Abfragen sowie Ihren letzten Abfrageverlauf in der Connect-Kundenkonsole einsehen. Weitere Informationen finden Sie unter Anzeigen laufender Abfragen oder des Abfrageverlaufs.

    • UploadContactFlowLog

      Ruft das Abfrageergebnis ab und lädt das Kontaktflussprotokoll in S3BucketName den Amazon S3-Bucket hoch, der unter angegeben ist.

    • GenerateReport

      Gibt die URL der Amazon S3-Konsole zurück, auf die das Kontaktflussprotokoll hochgeladen wurde, sowie einen AWS CLI-Beispielbefehl, den Sie zum Herunterladen der Protokolldatei verwenden können.

  7. Wenn Sie fertig sind, finden Sie im Abschnitt Ausgaben die detaillierten Ergebnisse der Ausführung:

    • GenerateReport.OutputPayload

      Ausgabe, die Ihnen mitteilt, dass das Runbook die Kontaktflussprotokolle für den angegebenen Kontakt erfolgreich abgerufen hat. Dieser Bericht enthält auch die URL der Amazon S3-Konsole und ein Beispiel für einen AWS CLI-Befehl, damit Sie die Protokolldatei herunterladen können.

    Ausgabe, die den erfolgreichen Abruf des Contact Flow-Protokolls mit der URL und dem AWS CLI Befehl der S3-Konsole zeigt.

Referenzen

Systems Manager Automation