CloudTrail / Client / start_query

start_query#

CloudTrail.Client.start_query(**kwargs)#

Starts a CloudTrail Lake query. The required QueryStatement parameter provides your SQL query, enclosed in single quotation marks. Use the optional DeliveryS3Uri parameter to deliver the query results to an S3 bucket.

See also: AWS API Documentation

Request Syntax

response = client.start_query(
    QueryStatement='string',
    DeliveryS3Uri='string'
)
Parameters:

  • QueryStatement (string) –

    [REQUIRED]

    The SQL code of your query.

  • DeliveryS3Uri (string) – The URI for the S3 bucket where CloudTrail delivers the query results.

Return type:

dict

Returns:

Response Syntax

{
    'QueryId': 'string'
}

Response Structure

  • (dict) –

    • QueryId (string) –

      The ID of the started query.

Exceptions

  • CloudTrail.Client.exceptions.EventDataStoreARNInvalidException

  • CloudTrail.Client.exceptions.EventDataStoreNotFoundException

  • CloudTrail.Client.exceptions.InactiveEventDataStoreException

  • CloudTrail.Client.exceptions.InvalidParameterException

  • CloudTrail.Client.exceptions.InvalidQueryStatementException

  • CloudTrail.Client.exceptions.MaxConcurrentQueriesException

  • CloudTrail.Client.exceptions.InsufficientEncryptionPolicyException

  • CloudTrail.Client.exceptions.InvalidS3PrefixException

  • CloudTrail.Client.exceptions.InvalidS3BucketNameException

  • CloudTrail.Client.exceptions.InsufficientS3BucketPolicyException

  • CloudTrail.Client.exceptions.S3BucketDoesNotExistException

  • CloudTrail.Client.exceptions.OperationNotPermittedException

  • CloudTrail.Client.exceptions.UnsupportedOperationException

  • CloudTrail.Client.exceptions.NoManagementAccountSLRExistsException