View a markdown version of this page

使用 記錄 Amazon Textract API 呼叫 AWS CloudTrail - Amazon Textract

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

使用 記錄 Amazon Textract API 呼叫 AWS CloudTrail

Amazon Textract 已與 服務整合 AWS CloudTrail,此服務提供 Amazon Textract AWS 中使用者、角色或服務所採取動作的記錄。CloudTrail 會將 Amazon Textract 的所有 API 呼叫擷取為事件。擷取的呼叫包括來自 Amazon Textract 主控台的呼叫,以及對 Amazon Textract API 操作的程式碼呼叫。

如果您建立線索,則可以將 CloudTrail 事件持續交付至 Amazon S3 儲存貯體,包括 Amazon Textract 的事件。即使您未設定追蹤,依然可以透過 CloudTrail 主控台中的事件歷史記錄檢視最新事件。您可以使用 CloudTrail 所收集的資訊,判斷對 Amazon Textract 提出的請求、提出請求的 IP 地址、提出請求的人員、提出請求的時間,以及其他詳細資訊。

若要進一步了解 CloudTrail,請參閱「AWS CloudTrail 使用者指南」

CloudTrail 中的 Amazon Textract 資訊

當您建立 AWS 帳戶時,會在您的帳戶上啟用 CloudTrail。當活動在 Amazon Textract 中發生時,該活動會與事件歷史記錄中的其他 AWS 服務事件一起記錄在 CloudTrail 事件中。您可以在 AWS 帳戶中檢視、搜尋和下載最近的事件。如需詳細資訊,請參閱《使用 CloudTrail 事件歷史記錄檢視事件》https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html

若要持續記錄您 AWS 帳戶中的事件,包括 Amazon Textract 的事件,請建立追蹤。線索能讓 CloudTrail 將日誌檔案交付至 Amazon S3 儲存貯體。根據預設,當您在主控台建立追蹤記錄時,追蹤記錄會套用到所有 AWS 區域。線索會記錄 AWS 分割區中所有區域的事件,並將日誌檔案傳送到您指定的 Amazon S3 儲存貯體。此外,您可以設定其他 AWS 服務,以進一步分析和處理 CloudTrail 日誌中所收集的事件資料。如需詳細資訊,請參閱下列內容:

CloudTrail 會記錄所有 Amazon Textract 操作,並記錄在 API 參考中。例如,對 DetectDocumentTextAnalyzeDocument 以及 GetDocumentText 動作發出的呼叫會在 CloudTrail 日誌檔案中產生項目。

每一筆事件或日誌專案都會包含產生請求者的資訊。身分資訊可協助您判斷下列事項:

  • 該請求是否使用根或使用者憑證提出。

  • 提出該請求時,是否使用了特定角色或聯合身分使用者的暫時安全憑證。

  • 請求是否由其他 AWS 服務提出。

如需詳細資訊,請參閱 CloudTrail userIdentity 元素

請求未記錄的參數和回應欄位

基於隱私權目的,不會記錄特定請求參數和回應欄位,例如請求映像位元組或回應週框方塊資訊。CloudTrail 日誌項目中提供請求參數中提供的 Amazon S3 儲存貯體名稱和檔案名稱。CloudTrail 日誌中未提供在請求中傳遞之映像位元組的相關資訊。下表顯示每個 Amazon Textract 操作未記錄的輸入參數和回應參數。

作業 請求參數 回應欄位

AnalyzeDocument

Bytes

全部

DetectDocumentText

Bytes

全部

StartDocumentAnalysis

GetDocumentAnalysis

全部

StartDocumentTextDetection

GetDocumentTextDetection

全部

了解 Amazon Textract 日誌檔案項目

追蹤是一種組態,能讓事件以日誌檔案的形式交付到您指定的 Amazon S3 儲存貯體。CloudTrail 日誌檔案包含一或多個日誌專案。一個事件代表任何來源提出的單一請求,並包含所請求之操作的相關資訊、操作的日期和時間、請求參數等等。CloudTrail 日誌檔案並非依公有 API 呼叫的堆疊追蹤排序,因此不會以任何特定順序出現。

以下範例顯示的 CloudTrail 日誌項目會示範 AnalyzeDocument 操作:不會記錄輸入的影像位元組document和分析結果 (responseElements)。

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

以下範例顯示 StartDocumentAnalysis 操作的 CloudTrail 日誌項目。日誌項目包含 中的 Amazon S3 儲存貯體名稱和映像檔案名稱documentLocation。日誌也包含 操作回應。

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