Journalisation des appels d'API Amazon Textract avecAWS CloudTrail

Amazon Textract est intégré àAWS CloudTrail, un service qui enregistre les actions réalisées par un utilisateur, un rôle ou unAWSservice dans Amazon Textract. CloudTrail capture tous les appels d'API pour Amazon Textract en tant qu'événements. Ces captures incluent les appels de la console Amazon Textract et les appels de code vers les opérations d'API Amazon Textract.

Si vous créez un journal d'activité, vous pouvez activer la livraison continue des événements CloudTrail dans un compartiment Amazon S3, y compris pour les événements relatifs à Amazon Textract. Si vous ne configurez pas de journal d'activité, vous pouvez toujours afficher les événements les plus récents dans la console CloudTrail dans Historique des événements. Avec les informations collectées par CloudTrail, vous pouvez déterminer la requête qui a été envoyée à Amazon Textract, 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, consultez le AWS CloudTrailGuide de l'utilisateur .

Informations Amazon Textract dans CloudTrail

CloudTrail est activé dans votre compte AWS lors de la création de ce dernier. Lorsqu'une activité a lieu dans Amazon Textract, cette activité est enregistrée dans un événement CloudTrail avec d'autresAWSévénements de service dansHistorique des événements. Vous pouvez afficher, rechercher et télécharger les événements récents dans votre compte AWS. Pour de plus amples informations, veuillez consulter Affichage des événements avec l'historique des événements CloudTrail.

Pour un registre permanent des événements dans votreAWScompte, y compris les événements pour Amazon Textract, créez un journal de suivi. Un journal d'activité permet à CloudTrail de distribuer les fichiers journaux vers Amazon S3 bucket. Par défaut, lorsque vous créez un journal d'activité dans la console, il s'applique à toutes les régions AWS. Le journal d'activité 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. De plus, vous pouvez configurer d'autresAWSpour analyser plus en profondeur les données d'événement collectées dans les journaux CloudTrail et agir sur celles-ci. Pour en savoir plus, consultez les ressources suivantes :

• Présentation de la création d'un journal d'activité

• Intégrations et services pris en charge par CloudTrail

• Configuration des Notifications de Amazon SNS pour CloudTrail

• Réception des fichiers journaux CloudTrail de plusieurs régions et Réception des fichiers journaux CloudTrail de plusieurs comptes

Toutes les opérations Amazon Textract sont enregistrées par CloudTrail et sont documentées dans le.API Reference. À titre d'exemple, les appels vers les actions DetectDocumentText, AnalyzeDocument et GetDocumentText génèrent des entrées dans les fichiers journaux CloudTrail.

Chaque événement ou entrée du journal contient des informations sur la personne qui a généré la demande. Les informations relatives à l'identité permettent de déterminer les éléments suivants :

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

• 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 plus d'informations, veuillez consulter l'élément userIdentity CloudTrail.

Paramètres de demande et champs de réponse qui ne sont pas consignés

Pour des raisons de confidentialité, certains paramètres de demande et champs de réponse ne sont pas consignés, par exemple, des octets d'image de demande ou des informations de zone de sélection de réponse. Les noms de compartiments Amazon S3 et les noms de fichiers fournis dans les paramètres de demande sont fournis dans les entrées de journal CloudTrail. Aucune information sur les octets d'image transmis dans une demande n'est fournie dans un journal CloudTrail. Le tableau suivant présente les paramètres d'entrée et les paramètres de réponse qui ne sont pas consignés pour chaque opération Amazon Textract.

Opération	Paramètres de demande	Champs de réponse
AnalyzeDocument	Bytes	Tous
DetectDocumentText	Bytes	Tous
StartDocumentAnalysis	Aucun	Aucun
GetDocumentAnalysis	Aucun	Tous
StartDocumentTextDetection	Aucun	Aucun
GetDocumentTextDetection	Aucun	Tous

Présentation des entrées des fichiers journaux Amazon Textract

Un journal de suivi est une configuration qui permet d'envoyer des événements sous forme de fichiers journaux à un compartiment Amazon S3 que vous spécifiez. Les fichiers journaux CloudTrail peuvent contenir une ou plusieurs entrées. Une entrée de journal représente une demande individuelle à partir d'une source quelconque et comprend des informations sur l'opération demandée, y compris la date et l'heure de l'opération, 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 publics. Ils ne suivent aucun ordre précis.

L'exemple suivant montre une entrée de journal CloudTrail qui illustre l'opération AnalyzeDocument. Les octets d'image de l'entréedocumentet les résultats d'analyse (responseElements) ne sont pas enregistrés.

{
    "eventVersion": "1.05",
    "userIdentity": {
        "type": "IAMUser",
        "principalId": "AIDACKCEVSQ6C2EXAMPLE",
        "arn": "arn:aws:iam::111111111111:user/janedoe",
        "accountId": "111111111111",
        "accessKeyId": "AIDACKCEVSQ6C2EXAMPLE",
        "userName": "janedoe"
    },
    "eventTime": "2019-04-03T23:56:31Z",
    "eventSource": "textract.amazonaws.com",
    "eventName": "AnalyzeDocument",
    "awsRegion": "us-east-1",
    "sourceIPAddress": "198.51.100.0",
    "userAgent": "",
    "requestParameters": {
        "document": {},
        "featureTypes": [
            "TABLES"
        ]
    },
    "responseElements": null,
    "requestID": "e387676b-d1f0-4ea7-85d6-f5a344052dce",
    "eventID": "c5db79ce-e4ea-4401-8517-784481d559f7",
    "eventType": "AwsApiCall",
    "recipientAccountId": "111111111111"
}

L'exemple suivant montre une entrée de journal CloudTrail pourStartDocumentAnalysis. L'entrée de journal inclut le nom du compartiment Amazon S3 et le nom du fichier image dansdocumentLocation. Le journal inclut également la réponse de l'opération.

{
    "Records": [
        {
            "eventVersion": "1.05",
            "userIdentity": {
                "type": "IAMUser",
                "principalId": "AIDACKCEVSQ6C2EXAMPLE",
                "arn": "arn:aws:iam::111111111111:user/janedoe",
                "accountId": "11111111111",
                "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
                "userName": "janedoe"
            },
            "eventTime": "2019-04-04T01:42:24Z",
            "eventSource": "textract.amazonaws.com",
            "eventName": "StartDocumentAnalysis",
            "awsRegion": "us-east-1",
            "sourceIPAddress": "198.51.100.0",
            "userAgent": "",
            "requestParameters": {
                "documentLocation": {
                    "s3Object": {
                        "bucket": "bucket",
                        "name": "document.png"
                    }
                },
                "featureTypes": [
                    "TABLES"
                ]
            },
            "responseElements": {
                "jobId": "f3c718b444fa603d5d625ab967008f4b620d4650c9db8ca1cae01ef7efe51373"
            },
            "requestID": "9ae352e8-9de1-41ad-b77b-85aa348c2e82",
            "eventID": "f741bca0-c3cb-4805-82ea-baf76439deef",
            "eventType": "AwsApiCall",
            "recipientAccountId": "111111111111"
        }

    ]
}