Journalisation des appels d'API Amazon Pinpoint à l'aide de AWS CloudTrail - Amazon Pinpoint

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.

Journalisation des appels d'API Amazon Pinpoint à l'aide de AWS CloudTrail

Amazon Pinpoint est intégré à AWS CloudTrail, qui est un service qui fournit un enregistrement des actions effectuées par un utilisateur, un rôle ou un service AWS dans Amazon Pinpoint. CloudTrail capture les appels d'API pour Amazon Pinpoint en tant qu'événements. Les appels capturés incluent les appels de la console Amazon Pinpoint et les appels de code vers les opérations d'API Amazon Pinpoint.

Si vous créez un journal d'activité, vous pouvez activer la distribution continue des événements CloudTrail dans un compartiment Amazon Simple Storage Service (Amazon S3, y compris les événements pour Amazon Pinpoint. Si vous ne configurez pas de suivi, vous pouvez toujours consulter les événements les plus récents en utilisant l'Historique des événements dans la console CloudTrail. Avec les informations collectées par CloudTrail, vous pouvez déterminer la requête qui a été envoyée à Amazon Pinpoint, l'adresse IP à partir de laquelle la requête a été exécutée, l'auteur et la date de la requête, ainsi que d'autres détails.

Pour en savoir plus sur CloudTrail, y compris la façon de le configurer et de l'activer, consultez le AWS CloudTrail Guide de l'utilisateur.

Informations relatives à Amazon Pinpoint dans CloudTrail

CloudTrail est activé dans votre compte AWS lors de la création de ce dernier. Quand une activité d'événement prise en charge a lieu dans Amazon Pinpoint, elle est enregistrée dans un événement CloudTrail avec d'autres événements de service AWS dans l'Historique des événements. Vous pouvez afficher, rechercher et télécharger les événements récents dans votre compte AWS. Pour plus d'informations, consultez Affichage des événements avec l'historique des événements CloudTrail.

Pour un enregistrement continu des événements de votre compte AWS, y compris les événements relatifs à Amazon Pinpoint, créez un journal de suivi. Un journal de suivi permet à CloudTrail de livrer des fichiers journaux dans un compartiment Amazon S3. Par défaut, lorsque vous créez un journal de suivi dans la console, il s'applique à toutes les régions AWS. Le journal de suivi consigne les événements de toutes les Régions dans la partition AWS et livre les fichiers journaux dans le compartiment Amazon S3 de votre choix. En outre, vous pouvez configurer d'autres services AWS pour analyser et agir sur les données d'événements collectées dans les journaux CloudTrail. Pour en savoir plus, consultez les ressources suivantes :

Chaque événement ou entrée de journal contient des informations sur la personne ayant initié la demande. Les informations relatives à l'identité vous permettent de déterminer :

  • Si la demande a été effectuée avec les informations d'identification utilisateur racine ou AWS Identity and Access Management.

  • Si la demande a été effectuée avec les informations d'identification de sécurité temporaires d'un rôle ou d'un utilisateur fédéré.

  • Si la requête a été effectuée par un autre service AWS.

Pour de plus amples informations, veuillez consulter Élément user Identity CloudTrail.

Vous pouvez créez un journal de suivi et stocker vos fichiers journaux dans votre compartiment Amazon S3 aussi longtemps que vous le souhaitez. Vous pouvez également définir des règles de cycle de vie d'Amazon S3 pour archiver ou supprimer les fichiers journaux automatiquement. Par défaut, vos fichiers journaux sont chiffrés avec le chiffrement côté serveur (SSE) d'Amazon S3.

Pour être averti de la remise des fichiers journaux, configurez CloudTrail pour qu'il publie des notifications Amazon SNS lorsque de nouveaux fichiers journaux sont remis. Pour plus d'informations, consultez Configuration des notifications Amazon SNS pour CloudTrail.

Vous pouvez également regrouper des fichiers journaux Amazon Pinpoint provenant de plusieurs régions AWS et de plusieurs comptes AWS dans un seul compartiment Amazon S3. Pour en savoir plus, consultez Recevoir les fichiers journaux de CloudTrail de plusieurs régions et Recevoir les fichiers CloudTrail de plusieurs comptes.

Vous pouvez utiliser CloudTrail pour journaliser les actions des API Amazon Pinpoint suivantes :

Actions de l'API Amazon Pinpoint pouvant être enregistrées par CloudTrail

L'API Amazon Pinpoint prend en charge la journalisation des actions suivantes en tant qu'événements dans les fichiers journaux CloudTrail :

Les actions d'API Amazon Pinpoint suivantes ne sont pas enregistrées dans CloudTrail :

  • PutEvents

  • SendMessages

  • SendUsersMessages

Actions de l'API d'e-mail Amazon Pinpoint pouvant être enregistrées par CloudTrail

L'API d'e-mail Amazon Pinpoint prend en charge la journalisation des actions suivantes en tant qu'événements dans les fichiers journaux CloudTrail :

L'action d'API d'e-mail Amazon Pinpoint suivante n'est pas enregistrée dans CloudTrail :

  • SendEmail

Actions de l'API SMS et voix Amazon Pinpoint version 1 pouvant être enregistrées par CloudTrail

L'API Amazon Pinpoint SMS et voix version 1 prend en charge la journalisation des actions suivantes en tant qu'événements dans les fichiers journaux CloudTrail :

L'action d'API SMS et voix Amazon Pinpoint version 1 suivante n'est pas enregistrée dans CloudTrail :

  • SendVoiceMessage

Actions de l'API SMS et voix Amazon Pinpoint version 2 pouvant être enregistrées par CloudTrail

L'API Amazon Pinpoint SMS et voix version 2 prend en charge la journalisation des actions suivantes en tant qu'événements dans les fichiers journaux CloudTrail :

Les actions d'API SMS et voix Amazon Pinpoint version 2 suivantes ne sont pas enregistrées dans CloudTrail :

Exemples : entrées de fichier journal Amazon Pinpoint

Un journal d'activité est une configuration qui permet d'envoyer des événements sous forme de fichiers journaux à un compartiment Simple Storage Service (Amazon S3) que vous spécifiez. Les fichiers journaux CloudTrail peuvent contenir une ou plusieurs entrées de journal. Un événement représente une demande unique d'une source quelconque. Il comprend les informations sur l'action demandée, la date et l'heure de l'action, les paramètres de la demande, etc. Les fichiers journaux CloudTrail ne constituent pas une série ordonnée retraçant les appels d'API publiques. Ils ne suivent aucun ordre précis.

L'exemple suivant montre une entrée de journal CloudTrail qui illustre les actions GetCampaigns et CreateCampaign de l'API Amazon Pinpoint.

{ "Records": [ { "awsRegion": "us-east-1", "eventID": "example0-09a3-47d6-a810-c5f9fd2534fe", "eventName": "GetCampaigns", "eventSource": "pinpoint.amazonaws.com", "eventTime": "2018-02-03T00:56:48Z", "eventType": "AwsApiCall", "eventVersion": "1.05", "readOnly": true, "recipientAccountId": "123456789012", "requestID": "example1-b9bb-50fa-abdb-80f274981d60", "requestParameters": { "application-id": "example71dfa4c1aab66332a5839798f", "page-size": "1000" }, "responseElements": null, "sourceIPAddress": "192.0.2.0", "userAgent": "Jersey/${project.version} (HttpUrlConnection 1.8.0_144)", "userIdentity": { "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "accountId": "123456789012", "arn": "arn:aws:iam::123456789012:root", "principalId": "123456789012", "sessionContext": { "attributes": { "creationDate": "2018-02-02T16:55:29Z", "mfaAuthenticated": "false" } }, "type": "Root" } }, { "awsRegion": "us-east-1", "eventID": "example0-09a3-47d6-a810-c5f9fd2534fe", "eventName": "CreateCampaign", "eventSource": "pinpoint.amazonaws.com", "eventTime": "2018-02-03T01:05:16Z", "eventType": "AwsApiCall", "eventVersion": "1.05", "readOnly": false, "recipientAccountId": "123456789012", "requestID": "example1-b9bb-50fa-abdb-80f274981d60", "requestParameters": { "Description": "***", "HoldoutPercent": 0, "IsPaused": false, "MessageConfiguration": "***", "Name": "***", "Schedule": { "Frequency": "ONCE", "IsLocalTime": true, "StartTime": "2018-02-03T00:00:00-08:00", "Timezone": "utc-08" }, "SegmentId": "exampleda204adf991a80281aa0e591", "SegmentVersion": 1, "application-id": "example71dfa4c1aab66332a5839798f" }, "responseElements": { "ApplicationId": "example71dfa4c1aab66332a5839798f", "CreationDate": "2018-02-03T01:05:16.425Z", "Description": "***", "HoldoutPercent": 0, "Id": "example54a654f80948680cbba240ede", "IsPaused": false, "LastModifiedDate": "2018-02-03T01:05:16.425Z", "MessageConfiguration": "***", "Name": "***", "Schedule": { "Frequency": "ONCE", "IsLocalTime": true, "StartTime": "2018-02-03T00:00:00-08:00", "Timezone": "utc-08" }, "SegmentId": "example4da204adf991a80281example", "SegmentVersion": 1, "State": { "CampaignStatus": "SCHEDULED" }, "Version": 1 }, "sourceIPAddress": "192.0.2.0", "userAgent": "aws-cli/1.14.9 Python/3.4.3 Linux/3.4.0+ botocore/1.8.34", "userIdentity": { "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "accountId": "123456789012", "arn": "arn:aws:iam::123456789012:user/userName", "principalId": "AIDAIHTHRCDA62EXAMPLE", "type": "IAMUser", "userName": "userName" } } ] }

L'exemple suivant montre une entrée de journal CloudTrail qui illustre les actions CreateConfigurationSet et CreateConfigurationSetEventDestination dans l'API SMS et voix Amazon Pinpoint.

{ "Records": [ { "eventVersion":"1.05", "userIdentity":{ "type":"IAMUser", "principalId":"AIDAIHTHRCDA62EXAMPLE", "arn":"arn:aws:iam::111122223333:user/SampleUser", "accountId":"111122223333", "accessKeyId":"AKIAIOSFODNN7EXAMPLE", "userName":"SampleUser" }, "eventTime":"2018-11-06T21:45:55Z", "eventSource":"sms-voice.amazonaws.com", "eventName":"CreateConfigurationSet", "awsRegion":"us-east-1", "sourceIPAddress":"192.0.0.1", "userAgent":"PostmanRuntime/7.3.0", "requestParameters":{ "ConfigurationSetName":"MyConfigurationSet" }, "responseElements":null, "requestID":"56dcc091-e20d-11e8-87d2-9994aexample", "eventID":"725843fc-8846-41f4-871a-7c52dexample", "readOnly":false, "eventType":"AwsApiCall", "recipientAccountId":"123456789012" }, { "eventVersion":"1.05", "userIdentity":{ "type":"IAMUser", "principalId":"AIDAIHTHRCDA62EXAMPLE", "arn":"arn:aws:iam::111122223333:user/SampleUser", "accountId":"111122223333", "accessKeyId":"AKIAIOSFODNN7EXAMPLE", "userName":"SampleUser" }, "eventTime":"2018-11-06T21:47:08Z", "eventSource":"sms-voice.amazonaws.com", "eventName":"CreateConfigurationSetEventDestination", "awsRegion":"us-east-1", "sourceIPAddress":"192.0.0.1", "userAgent":"PostmanRuntime/7.3.0", "requestParameters":{ "EventDestinationName":"CloudWatchEventDestination", "ConfigurationSetName":"MyConfigurationSet", "EventDestination":{ "Enabled":true, "MatchingEventTypes":[ "INITIATED_CALL", "INITIATED_CALL" ], "CloudWatchLogsDestination":{ "IamRoleArn":"arn:aws:iam::111122223333:role/iamrole-01", "LogGroupArn":"arn:aws:logs:us-east-1:111122223333:log-group:clientloggroup-01" } } }, "responseElements":null, "requestID":"81de1e73-e20d-11e8-b158-d5536example", "eventID":"fcafc21f-7c93-4a3f-9e72-fca2dexample", "readOnly":false, "eventType":"AwsApiCall", "recipientAccountId":"111122223333" } ] }