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.

Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. If the query results were delivered to an S3 bucket, the response also provides the S3 URI and the delivery status.

You must specify either QueryId or QueryAlias. Specifying the QueryAlias parameter returns information about the last query run for the alias. You can provide RefreshId along with QueryAlias to view the query results of a dashboard query for the specified RefreshId.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDescribeQuery and EndDescribeQuery.

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

Syntax

C#
public virtual Task<DescribeQueryResponse> DescribeQueryAsync(
         DescribeQueryRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CloudTrail.Model.DescribeQueryRequest

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

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DescribeQuery 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.
InvalidParameterException The request includes a parameter that is not valid.
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.
QueryIdNotFoundException The query ID does not exist or does not map to a query.
UnsupportedOperationException This exception is thrown when the requested operation is not supported.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also