Registro de llamadas a la API de Amazon Textract conAWS CloudTrail

Amazon Textract se integra conAWS CloudTrail, un servicio que proporciona un registro de las acciones que realiza un usuario, un rol o un rolAWSservicio en Amazon Textract. CloudTrail captura todas las llamadas a la API para Amazon Textract como eventos. Las llamadas capturadas incluyen las llamadas desde la consola de Amazon Textract llamadas desde el código a las operaciones de la API de Amazon Textract Texact.

Si crea un registro de seguimiento, puede habilitar la entrega continua de eventos de CloudTrail a un bucket de Amazon S3, incluidos los eventos de Amazon Textract. Si no configura un registro de seguimiento, puede ver los eventos más recientes de la consola de CloudTrail en el Event history (Historial de eventos). Mediante la información recopilada por CloudTrail, puede determinar la solicitud que se realizó a Amazon Textract Texact, la dirección IP desde la que se realizó la solicitud, quién realizó la solicitud, cuándo se realizó y detalles adicionales.

Para obtener más información acerca de CloudTrail, consulte la AWS CloudTrailGuía del usuario de .

Información de Amazon Textract en CloudTrail

CloudTrail se habilita en su cuenta de AWS cuando la crea. Cuando se produce una actividad en Amazon Textract Texact, esta se registra en un evento de CloudTrail junto con otrosAWSeventos de servicio enHistorial de eventos. Puede ver, buscar y descargar los últimos eventos de la cuenta de AWS. Para obtener más información, consulte Ver eventos con el historial de eventos de CloudTrail.

Para mantener un registro continuo de los eventos deAWS, incluidos los eventos de Amazon Textract, cree un registro de seguimiento. Un registro de seguimiento permite a CloudTrail enviar archivos de registro a un bucket de Amazon S3. De forma predeterminada, cuando se crea un registro de seguimiento en la consola, el registro de seguimiento se aplica a todas las regiones de AWS. El registro de seguimiento registra los eventos de todas las regiones de la partición de AWS y envía los archivos de registro al bucket de Amazon S3 especificado. Además, puede configurar otrosAWSservicios para analizar y actuar en función de los datos de eventos recopilados en los registros de CloudTrail. Para obtener más información, consulte los siguientes:

• Introducción a la creación de registros de seguimiento

• Servicios e integraciones compatibles con CloudTrail

• Configuración de notificaciones de Amazon SNS para CloudTrail

• Recibir archivos de registro de CloudTrail de varias regiones y Recibir archivos de registro de CloudTrail de varias cuentas

CloudTrail registra todas las operaciones de Amazon Textract y se documentan en laReferencia de la API. Por ejemplo, las llamadas a las acciones DetectDocumentText, AnalyzeDocument y GetDocumentText generan entradas en los archivos de log de CloudTrail.

Cada entrada de registro o evento contiene información sobre quién generó la solicitud. La información de identidad del usuario le ayuda a determinar lo siguiente:

• Si la solicitud se realizó con credenciales de usuario AWS Identity and Access Management (IAM) o credenciales de usuario raíz.

• Si la solicitud se realizó con credenciales de seguridad temporales de un rol o fue un usuario federado.

• Si la solicitud la realizó otro servicio de AWS.

Para obtener más información, consulte el Elemento userIdentity de CloudTrail.

Parámetros de solicitud y campos de respuesta que no están registrados

Por motivos de privacidad, algunos parámetros de solicitud y campos de respuesta no se registran, por ejemplo, bytes de imagen de solicitud o información del cuadro delimitador de respuestas. Los nombres de bucket y los nombres de archivo de Amazon S3 suministrados en los parámetros de solicitud se proporcionan en las entradas de registro de CloudTrail No se proporciona información sobre los bytes de imagen transmitidos en una solicitud en un registro de CloudTrail. En la tabla siguiente se muestran los parámetros de entrada y los parámetros de respuesta que no se registran para cada operación de Amazon Textract Texact.

Operación	Parámetros de solicitud	Campos de respuesta
AnalyzeDocument	Bytes	Todos
DetectDocumentText	Bytes	Todos
StartDocumentAnalysis	Ninguno	Ninguno
GetDocumentAnalysis	Ninguno	Todos
StartDocumentTextDetection	Ninguno	Ninguno
GetDocumentTextDetection	Ninguno	Todos

Descripción de las entradas de archivos de registro de Amazon Textract

Un registro de seguimiento es una configuración que permite la entrega de eventos como archivos de registros en un bucket de Amazon S3 que especifique. Los archivos log de CloudTrail pueden contener una o varias entradas de log. Un evento representa una única solicitud de cualquier origen e incluye información sobre la operación solicitada, la fecha y la hora de la operación, los parámetros de la solicitud, etcétera. Los archivos de registro de CloudTrail no rastrean el orden en la pila de las llamadas públicas a la API, por lo que estas no aparecen en ningún orden específico.

En el ejemplo que sigue se muestra una entrada de registro de CloudTrail que ilustra la operación AnalyzeDocument. Los bytes de imagen de la entradadocumenty los resultados del análisis (responseElements) no están registrados.

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

En el siguiente ejemplo, se muestra una entrada de registro de CloudTrail para laStartDocumentAnalysis. La entrada de registro incluye el nombre del bucket de Amazon S3 y el nombre del archivo de imagen endocumentLocation. El registro también incluye la respuesta de la operación.

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

    ]
}