CloudTrail / Client / generate_query

generate_query#

CloudTrail.Client.generate_query(**kwargs)#

Generates a query from a natural language prompt. This operation uses generative artificial intelligence (generative AI) to produce a ready-to-use SQL query from the prompt.

The prompt can be a question or a statement about the event data in your event data store. For example, you can enter prompts like “What are my top errors in the past month?” and “Give me a list of users that used SNS.”

The prompt must be in English. For information about limitations, permissions, and supported Regions, see Create CloudTrail Lake queries from natural language prompts in the CloudTrail user guide.

Note

Do not include any personally identifying, confidential, or sensitive information in your prompts.

This feature uses generative AI large language models (LLMs); we recommend double-checking the LLM response.

See also: AWS API Documentation

Request Syntax

response = client.generate_query(
    EventDataStores=[
        'string',
    ],
    Prompt='string'
)
Parameters:

  • EventDataStores (list) –

    [REQUIRED]

    The ARN (or ID suffix of the ARN) of the event data store that you want to query. You can only specify one event data store.

    • (string) –

  • Prompt (string) –

    [REQUIRED]

    The prompt that you want to use to generate the query. The prompt must be in English. For example prompts, see Example prompts in the CloudTrail user guide.

Return type:

dict

Returns:

Response Syntax

{
    'QueryStatement': 'string',
    'QueryAlias': 'string',
    'EventDataStoreOwnerAccountId': 'string'
}

Response Structure

  • (dict) –

    • QueryStatement (string) –

      The SQL query statement generated from the prompt.

    • QueryAlias (string) –

      An alias that identifies the prompt. When you run the StartQuery operation, you can pass in either the QueryAlias or QueryStatement parameter.

    • EventDataStoreOwnerAccountId (string) –

      The account ID of the event data store owner.

Exceptions

  • CloudTrail.Client.exceptions.EventDataStoreARNInvalidException

  • CloudTrail.Client.exceptions.EventDataStoreNotFoundException

  • CloudTrail.Client.exceptions.InactiveEventDataStoreException

  • CloudTrail.Client.exceptions.InvalidParameterException

  • CloudTrail.Client.exceptions.GenerateResponseException

  • CloudTrail.Client.exceptions.OperationNotPermittedException

  • CloudTrail.Client.exceptions.UnsupportedOperationException

  • CloudTrail.Client.exceptions.NoManagementAccountSLRExistsException