View a markdown version of this page

AWSSupport-CollectAmazonConnectContactFlowLog - AWS Systems Manager Référence du dossier d’exploitation Automation

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

AWSSupport-CollectAmazonConnectContactFlowLog

Description

Le runbook AWSSupport-CollectAmazonConnectContactFlowLog d'automatisation est utilisé pour collecter les journaux de flux de contacts Connect Customer pour un identifiant de contact spécifique. En fournissant votre ID d'instance Connect Customer et votre ID de contact, le runbook recherche dans les journaux de flux de contacts le contact du groupe de CloudWatch journaux Amazon et le télécharge dans le compartiment Amazon Simple Storage Service (Amazon S3) spécifié dans le paramètre de demande. Le runbook génère une sortie qui fournit l'URL de la console Amazon S3 et la commande AWS CLI vous permettant de télécharger les journaux.

Fonctionnement

Le runbook AWSSupport-CollectAmazonConnectContactFlowLog d'automatisation permet de collecter les journaux des flux de contacts Connect Customer pour un identifiant de contact spécifique stocké dans le groupe de CloudWatch journaux configuré et de les télécharger vers un compartiment Amazon S3 spécifié. Pour renforcer la sécurité des journaux collectés à partir de votre flux de contacts Connect Customer, l'automatisation évalue la configuration du compartiment Amazon S3 afin de déterminer si le compartiment accorde des autorisations publiques read ou d'writeaccès et appartient au AWS compte spécifié dans le S3BucketOwnerAccountId paramètre. Si votre compartiment Amazon S3 utilise le chiffrement côté serveur avec des AWS Key Management Service clés (SSE-KMS), assurez-vous que l'utilisateur ou le rôle Gestion des identités et des accès AWS (IAM) qui exécute cette automatisation dispose des kms:GenerateDataKey autorisations sur la clé. AWS KMS Pour plus d'informations sur les journaux générés par votre instance Connect Customer, consultez la section Journaux de flux stockés dans un groupe de CloudWatch journaux Amazon.

Important

Les requêtes CloudWatch Logs Insights sont facturées en fonction de la quantité de données demandées. Les clients bénéficiant d'une offre gratuite sont uniquement facturés lorsque leur utilisation dépasse les quotas de service. Pour en savoir plus, consultez Tarification Amazon CloudWatch.

Exécutez cette automatisation (console)

Type de document

 Automatisation

Propriétaire

Amazon

Plateformes

LinuxmacOS, Windows

Paramètres

Autorisations IAM requises

Le AutomationAssumeRole paramètre nécessite les actions suivantes pour utiliser correctement le runbook.


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

Instructions

Pour configurer l'automatisation, procédez comme suit :

  1. Accédez à AWSSupport-CollectAmazonConnectContactFlowLog la section Documents dans Systems Manager.

  2. Sélectionnez Execute automation (Exécuter l'automatisation).

  3. Pour les paramètres d'entrée, entrez les informations suivantes :

    • AutomationAssumeRole (Facultatif) :

      Le nom de ressource Amazon (ARN) du rôle Gestion des identités et des accès AWS (IAM) qui permet à Systems Manager Automation d'effectuer les actions en votre nom. Si aucun rôle n'est spécifié, Systems Manager Automation utilise les autorisations de l'utilisateur qui démarre ce runbook.

    • ConnectInstanceId (Obligatoire) :

      L'ID de votre instance Connect Customer.

    • ContactId (Obligatoire) :

      L'ID du contact pour lequel vous souhaitez collecter le journal des flux de contacts.

    • S3BucketName (Obligatoire) :

      Le nom du compartiment Amazon S3 de votre compte dans lequel vous souhaitez télécharger le journal des flux de contacts. Assurez-vous que la politique en matière de bucket n'accorde pas d' read/writeautorisations inutiles aux parties qui n'ont pas besoin d'accéder aux journaux collectés.

    • S3ObjectPrefix (Facultatif) :

      Le chemin de l'objet Amazon S3 dans le compartiment Amazon S3 pour un journal de flux de contacts chargé. Par exemple, si vous le spécifiezCollectedLogs, le journal sera chargé en tant ques3://your-s3-bucket/CollectedLogs/ContactFlowLog_[ContactId][AWSAccountId].gz. Si vous ne spécifiez pas ce paramètre, l'ID d'exécution de Systems Manager Automation est utilisé, par exemple :s3://your-s3-bucket/[automation:EXECUTION_ID]/ContactFlowLog[ContactId]_[AWSAccountId].gz. Remarque : si vous spécifiez une valeur pour S3ObjectPrefix et exécutez cette automatisation en utilisant le même [ContactId], le journal des flux de contacts sera remplacé.

    • S3BucketOwnerAccount (Facultatif) :

      Le numéro de AWS compte auquel appartient le compartiment Amazon S3 dans lequel vous souhaitez télécharger le journal des flux de contacts. Si vous ne spécifiez pas ce paramètre, le runbook utilise l'ID de AWS compte de l'utilisateur ou du rôle dans lequel l'automatisation s'exécute.

    • S3BucketOwnerRoleArn (Facultatif) :

      L'ARN du rôle IAM avec les autorisations nécessaires pour obtenir les paramètres d'accès public au compartiment et au blocage du compte Amazon S3, la configuration du chiffrement du compartiment, les ACL du compartiment, l'état de la politique du compartiment et le téléchargement d'objets dans le compartiment. Si ce paramètre n'est pas spécifié, le runbook utilise l'utilisateur AutomationAssumeRole (si spécifié) ou l'utilisateur qui démarre ce runbook (s'il n'AutomationAssumeRoleest pas spécifié). Consultez la section sur les autorisations requises dans la description du runbook.

    Formulaire de paramètres d'entrée pour AWS Systems Manager Automation avec des champs pour les rôles, les ID et les paramètres S3.

  4. Sélectionnez Exécuter.

  5. L'automatisation démarre.

  6. Le document exécute les étapes suivantes :

    • CheckConnectInstanceExistance

      Vérifie si l'instance Connect Customer fournie dans le ConnectInstanceId estACTIVE.

    • CheckS3BucketPublicStatus

      Vérifie si le compartiment Amazon S3 spécifié dans le S3BucketName autorise des autorisations d'accès anonymes ou publiques en lecture ou en écriture.

    • GenerateLogSearchTimeRange

      Génère StartTime et EndTime pour l'StartQueryétape en fonction de la InitiationTimestamp valeur et LastUpdateTimestamp renvoyée par l'DescribeContactAPI. StartTimeaura lieu une heure avant InitiationTimestamp et EndTime une heure aprèsLastUpdateTimestamp.

    • StartQuery

      Démarre un journal des requêtes pour les éléments fournis ContactId dans le groupe de CloudWatch journaux Logs associé à l'instance Connect Customer fournie dansConnectInstanceId. Les requêtes sont interrompues après 60 minutes d'exécution. Si votre requête arrive à expiration, réduisez la période de recherche. Vous pouvez consulter les requêtes en cours ainsi que l'historique de vos requêtes récentes dans la CloudWatch console. Pour plus d'informations, voir Afficher les requêtes en cours ou l'historique des requêtes.

    • WaitForQueryCompletion

      Attend la fin du CloudWatch journal des requêtes Logs fourniContactId. Notez que la requête expire après 60 minutes d'exécution. Si votre requête arrive à expiration, réduisez la période de recherche. Vous pouvez consulter les requêtes en cours ainsi que l'historique de vos requêtes récentes dans la console Connect Customer. Pour plus d'informations, voir Afficher les requêtes en cours ou l'historique des requêtes.

    • UploadContactFlowLog

      Obtient le résultat de la requête et télécharge le journal des flux de contacts dans le compartiment Amazon S3 spécifié dansS3BucketName.

    • GenerateReport

      Renvoie l'URL de la console Amazon S3 où le journal des flux de contacts a été chargé et un exemple de commande AWS CLI que vous pouvez utiliser pour télécharger le fichier journal.

  7. Une fois terminé, consultez la section Sorties pour obtenir les résultats détaillés de l'exécution :

    • GenerateReport.OutputPayload

      Sortie indiquant que le runbook a correctement récupéré les journaux de flux de contacts pour le contact spécifié. Ce rapport contient également l'URL de la console Amazon S3 et un exemple de commande AWS CLI vous permettant de télécharger le fichier journal.

    Sortie montrant la récupération réussie du journal Contact Flow avec l'URL et la AWS CLI commande de la console S3.

Références

Systems Manager Automation