Registro de chamadas da API do Amazon Kendra Intelligent Ranking com logs do AWS CloudTrail

O AAmazon Kendra Intelligent Ranking é integrado ao AWS CloudTrail, serviço que fornece um registro das ações executadas por um usuário, uma função ou um serviço da AWS no Amazon Kendra Intelligent Ranking. O CloudTrail captura todas as chamadas de API do Amazon Kendra Intelligent Ranking como eventos, incluindo as chamadas de código para as APIs do Amazon Kendra Intelligent Ranking. Se você criar uma trilha, poderá ativar a entrega contínua de eventos do CloudTrail para um bucket do Amazon S3, incluindo eventos para o Amazon Kendra Intelligent Ranking. Se você não configurar uma trilha, ainda poderá visualizar os eventos mais recentes no console do CloudTrail em Histórico de eventos. Usando as informações coletadas pelo CloudTrail, é possível determinar a solicitação feita para o Amazon Kendra Intelligent Ranking, o endereço IP do qual a solicitação foi feita, quem fez a solicitação, quando ela foi feita e detalhes adicionais.

Para saber mais sobre o CloudTrail, incluindo como configurá-lo e ativá-lo, consulte o Guia do usuário do AWS CloudTrail.

Informações do Amazon Kendra Intelligent Ranking no CloudTrail

O CloudTrail é ativado em sua conta da AWS quando ela é criada. Quando ocorre qualquer atividade no Amazon Kendra Intelligent Ranking, essa atividade é registrada em um evento do CloudTrail junto com outros eventos de serviços da AWS no Histórico de eventos do CloudTrail. É possível visualizar, pesquisar e baixar eventos recentes em sua AWS conta. Para obter mais informações, consulte Visualização de eventos com o histórico de eventos do CloudTrail.

Para obter um registro contínuo de eventos da conta da AWS, incluindo eventos do Amazon Kendra Intelligent Ranking, crie uma trilha. Uma trilha é uma configuração que permite ao CloudTrail entregar eventos como arquivos de log a um bucket do S3 especificado. Por padrão, ao criar uma trilha no console, ela é aplicada a todas as regiões da AWS. A trilha registra eventos de todas as regiões na partição da AWS e fornece os arquivos de log ao bucket do S3 que você especificar. Além disso, é possível configurar outros serviços da AWS para analisar e agir melhor com base nos dados de eventos coletados nos logs do CloudTrail. Para obter mais informações, consulte:

O CloudTrail registra todas as ações do Amazon Kendra Intelligent Ranking, que estão documentadas na Referência da API. Por exemplo, chamadas para o CreateRescoreExecutionPlan gerar entradas nos arquivos de log do CloudTrail.

Cada entrada de log ou evento contém informações sobre quem gerou a solicitação. Para obter mais informações, consulte o Elemento de identidade do usuário do CloudTrail.

Exemplo: entradas de arquivos de log do Amazon Kendra Intelligent Ranking

Uma trilha é uma configuração que permite a entrega de eventos como arquivos de log a um bucket do S3 especificado. Os arquivos de log CloudTrail contêm uma ou mais entradas de log. Um evento representa uma única solicitação de qualquer origem e inclui informações sobre a ação solicitada, a data e a hora da ação, os parâmetros de solicitação e assim por diante. Os arquivos de log do CloudTrail não são um rastreamento de pilha ordenada de chamadas de API pública, portanto, não são exibidos em uma ordem específica.

As chamadas para a operação de CreateRescoreExecutionPlan criam a seguinte entrada:

{
            "eventVersion": "1.08",
            "userIdentity": {
                "type": "AssumedRole",
                "principalId": "principal ID",
                "arn": "ARN",
                "accountId": "account ID",
                "accessKeyId": "access key ID",
                "sessionContext": {
                    "sessionIssuer": {
                        "type": "Role",
                        "principalId": "principal ID",
                        "arn": "ARN",
                        "accountId": "account ID",
                        "userName": "user name"
                    },
                    "webIdFederationData": {},
                    "attributes": {
                        "creationDate": "yyyy-mm-ddThh:mm:ssZ",
                        "mfaAuthenticated": "false"
                    }
                }
            },
            "eventTime": "yyyy-mm-ddThh:mm:ssZ",
            "eventSource": "kendra-ranking.amazonaws.com",
            "eventName": "CreateRescoreExecutionPlan",
            "awsRegion": "region",
            "sourceIPAddress": "source IP address",
            "userAgent": "user agent",
            "requestParameters": {
                "name": "name",
                "description": "description",
                "clientToken": "client token"
            },
            "responseElements": {
                "id": "rescore execution plan ID",
                "arn": "rescore execution plan ARN"
            },
            "requestID": "request ID",
            "eventID": "event ID",
            "readOnly": false,
            "eventType": "AwsApiCall",
            "managementEvent": true,
            "recipientAccountId": "account ID",
            "eventCategory": "Management",
            "tlsDetails": {
                "tlsVersion": "TLS version",
                "cipherSuite": "cipher suite",
                "clientProvidedHostHeader": "kendra-ranking.[region].api.aws"
            }
        }