AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

StartQuery requires you specify either the QueryStatement parameter, or a QueryAlias and any QueryParameters. In the current release, the QueryAlias and QueryParameters parameters are used only for the queries that populate the CloudTrail Lake dashboards.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to StartQueryAsync.

Namespace: Amazon.CloudTrail
Assembly: AWSSDK.CloudTrail.dll
Version: 3.x.y.z

Syntax

C#
public virtual StartQueryResponse StartQuery(
         StartQueryRequest request
)

Parameters

request
Type: Amazon.CloudTrail.Model.StartQueryRequest

Container for the necessary parameters to execute the StartQuery service method.

Return Value


The response from the StartQuery service method, as returned by CloudTrail.

Exceptions

ExceptionCondition
EventDataStoreARNInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
EventDataStoreNotFoundException The specified event data store was not found.
InactiveEventDataStoreException The event data store is inactive.
InsufficientEncryptionPolicyException This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
InsufficientS3BucketPolicyException This exception is thrown when the policy on the S3 bucket is not sufficient.
InvalidParameterException The request includes a parameter that is not valid.
InvalidQueryStatementException The query that was submitted has validation errors, or uses incorrect syntax or unsupported keywords. For more information about writing a query, see Create or edit a query in the CloudTrail User Guide.
InvalidS3BucketNameException This exception is thrown when the provided S3 bucket name is not valid.
InvalidS3PrefixException This exception is thrown when the provided S3 prefix is not valid.
MaxConcurrentQueriesException You are already running the maximum number of concurrent queries. The maximum number of concurrent queries is 10. Wait a minute for some queries to finish, and then run the query again.
NoManagementAccountSLRExistsException This exception is thrown when the management account does not have a service-linked role.
OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
S3BucketDoesNotExistException This exception is thrown when the specified S3 bucket does not exist.
UnsupportedOperationException This exception is thrown when the requested operation is not supported.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also