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.

Container for the parameters to the StartQueryExecution operation. Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup in which the query ran. Running queries against an external catalog requires GetDataCatalog permission to the catalog. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Athena.AmazonAthenaRequest
      Amazon.Athena.Model.StartQueryExecutionRequest

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

Syntax

C# 
public class StartQueryExecutionRequest : AmazonAthenaRequest
         IAmazonWebServiceRequest

The StartQueryExecutionRequest type exposes the following members

Constructors

NameDescription
Public Method StartQueryExecutionRequest()

Properties

NameTypeDescription
Public Property ClientRequestToken System.String

Gets and sets the property ClientRequestToken.

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. An error is returned if a parameter, such as QueryString, has changed. A call to StartQueryExecution that uses a previous client request token returns the same QueryExecutionId even if the requester doesn't have permission on the tables specified in QueryString.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

Public Property ExecutionParameters System.Collections.Generic.List<System.String>

Gets and sets the property ExecutionParameters.

A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.

Public Property QueryExecutionContext Amazon.Athena.Model.QueryExecutionContext

Gets and sets the property QueryExecutionContext.

The database within which the query executes.

Public Property QueryString System.String

Gets and sets the property QueryString.

The SQL query statements to be executed.

Public Property ResultConfiguration Amazon.Athena.Model.ResultConfiguration

Gets and sets the property ResultConfiguration.

Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Public Property ResultReuseConfiguration Amazon.Athena.Model.ResultReuseConfiguration

Gets and sets the property ResultReuseConfiguration.

Specifies the query result reuse behavior for the query.

Public Property WorkGroup System.String

Gets and sets the property WorkGroup.

The name of the workgroup in which the query is being started.

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, 3.5