Aws::Athena::Model::StartQueryExecutionRequest Class Reference

#include <StartQueryExecutionRequest.h>

Inheritance diagram for Aws::Athena::Model::StartQueryExecutionRequest:

Public Member Functions
	StartQueryExecutionRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const Aws::String &	GetQueryString () const
bool	QueryStringHasBeenSet () const
void	SetQueryString (const Aws::String &value)
void	SetQueryString (Aws::String &&value)
void	SetQueryString (const char *value)
StartQueryExecutionRequest &	WithQueryString (const Aws::String &value)
StartQueryExecutionRequest &	WithQueryString (Aws::String &&value)
StartQueryExecutionRequest &	WithQueryString (const char *value)
const Aws::String &	GetClientRequestToken () const
bool	ClientRequestTokenHasBeenSet () const
void	SetClientRequestToken (const Aws::String &value)
void	SetClientRequestToken (Aws::String &&value)
void	SetClientRequestToken (const char *value)
StartQueryExecutionRequest &	WithClientRequestToken (const Aws::String &value)
StartQueryExecutionRequest &	WithClientRequestToken (Aws::String &&value)
StartQueryExecutionRequest &	WithClientRequestToken (const char *value)
const QueryExecutionContext &	GetQueryExecutionContext () const
bool	QueryExecutionContextHasBeenSet () const
void	SetQueryExecutionContext (const QueryExecutionContext &value)
void	SetQueryExecutionContext (QueryExecutionContext &&value)
StartQueryExecutionRequest &	WithQueryExecutionContext (const QueryExecutionContext &value)
StartQueryExecutionRequest &	WithQueryExecutionContext (QueryExecutionContext &&value)
const ResultConfiguration &	GetResultConfiguration () const
bool	ResultConfigurationHasBeenSet () const
void	SetResultConfiguration (const ResultConfiguration &value)
void	SetResultConfiguration (ResultConfiguration &&value)
StartQueryExecutionRequest &	WithResultConfiguration (const ResultConfiguration &value)
StartQueryExecutionRequest &	WithResultConfiguration (ResultConfiguration &&value)
const Aws::String &	GetWorkGroup () const
bool	WorkGroupHasBeenSet () const
void	SetWorkGroup (const Aws::String &value)
void	SetWorkGroup (Aws::String &&value)
void	SetWorkGroup (const char *value)
StartQueryExecutionRequest &	WithWorkGroup (const Aws::String &value)
StartQueryExecutionRequest &	WithWorkGroup (Aws::String &&value)
StartQueryExecutionRequest &	WithWorkGroup (const char *value)
Public Member Functions inherited from Aws::Athena::AthenaRequest
virtual	~AthenaRequest ()
void	AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
Aws::Http::HeaderValueCollection	GetHeaders () const override
Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
	AmazonSerializableWebServiceRequest ()
virtual	~AmazonSerializableWebServiceRequest ()
std::shared_ptr< Aws::IOStream >	GetBody () const override
Public Member Functions inherited from Aws::AmazonWebServiceRequest
	AmazonWebServiceRequest ()
virtual	~AmazonWebServiceRequest ()=default
virtual void	AddQueryStringParameters (Aws::Http::URI &uri) const
virtual void	PutToPresignedUrl (Aws::Http::URI &uri) const
virtual bool	IsStreaming () const
virtual bool	IsEventStreamRequest () const
virtual bool	SignBody () const
virtual bool	IsChunked () const
virtual void	SetRequestSignedHandler (const RequestSignedHandler &handler)
virtual const RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () const
void	SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
virtual void	SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
virtual void	SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
virtual void	SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
virtual void	SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
virtual void	SetRequestRetryHandler (const RequestRetryHandler &handler)
virtual void	SetRequestRetryHandler (RequestRetryHandler &&handler)
virtual const Aws::Http::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () const
virtual bool	ShouldComputeContentMd5 () const

Additional Inherited Members
Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void	DumpBodyToUrl (Aws::Http::URI &uri) const

Detailed Description

Definition at line 24 of file StartQueryExecutionRequest.h.

Constructor & Destructor Documentation

StartQueryExecutionRequest()

Aws::Athena::Model::StartQueryExecutionRequest::StartQueryExecutionRequest

(

)

Member Function Documentation

ClientRequestTokenHasBeenSet()

bool Aws::Athena::Model::StartQueryExecutionRequest::ClientRequestTokenHasBeenSet ( ) const

inline

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. If a parameter has changed, for example, the QueryString, an error is returned.

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

Definition at line 103 of file StartQueryExecutionRequest.h.

GetClientRequestToken()

const Aws::String& Aws::Athena::Model::StartQueryExecutionRequest::GetClientRequestToken ( ) const

inline

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. If a parameter has changed, for example, the QueryString, an error is returned.

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

Definition at line 91 of file StartQueryExecutionRequest.h.

GetQueryExecutionContext()

const QueryExecutionContext& Aws::Athena::Model::StartQueryExecutionRequest::GetQueryExecutionContext ( ) const

inline

The database within which the query executes.

Definition at line 181 of file StartQueryExecutionRequest.h.

GetQueryString()

const Aws::String& Aws::Athena::Model::StartQueryExecutionRequest::GetQueryString ( ) const

inline

The SQL query statements to be executed.

Definition at line 43 of file StartQueryExecutionRequest.h.

GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Athena::Model::StartQueryExecutionRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::Athena::AthenaRequest.

GetResultConfiguration()

const ResultConfiguration& Aws::Athena::Model::StartQueryExecutionRequest::GetResultConfiguration ( ) const

inline

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.

Definition at line 217 of file StartQueryExecutionRequest.h.

GetServiceRequestName()

virtual const char* Aws::Athena::Model::StartQueryExecutionRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file StartQueryExecutionRequest.h.

GetWorkGroup()

const Aws::String& Aws::Athena::Model::StartQueryExecutionRequest::GetWorkGroup ( ) const

inline

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

Definition at line 273 of file StartQueryExecutionRequest.h.

QueryExecutionContextHasBeenSet()

bool Aws::Athena::Model::StartQueryExecutionRequest::QueryExecutionContextHasBeenSet ( ) const

inline

The database within which the query executes.

Definition at line 186 of file StartQueryExecutionRequest.h.

QueryStringHasBeenSet()

bool Aws::Athena::Model::StartQueryExecutionRequest::QueryStringHasBeenSet ( ) const

inline

The SQL query statements to be executed.

Definition at line 48 of file StartQueryExecutionRequest.h.

ResultConfigurationHasBeenSet()

bool Aws::Athena::Model::StartQueryExecutionRequest::ResultConfigurationHasBeenSet ( ) const

inline

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.

Definition at line 227 of file StartQueryExecutionRequest.h.

SerializePayload()

Aws::String Aws::Athena::Model::StartQueryExecutionRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetClientRequestToken() [1/3]

void Aws::Athena::Model::StartQueryExecutionRequest::SetClientRequestToken ( const Aws::String &  value )

inline

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. If a parameter has changed, for example, the QueryString, an error is returned.

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

Definition at line 115 of file StartQueryExecutionRequest.h.

SetClientRequestToken() [2/3]

void Aws::Athena::Model::StartQueryExecutionRequest::SetClientRequestToken ( Aws::String &&  value )

inline

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. If a parameter has changed, for example, the QueryString, an error is returned.

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

Definition at line 127 of file StartQueryExecutionRequest.h.

SetClientRequestToken() [3/3]

void Aws::Athena::Model::StartQueryExecutionRequest::SetClientRequestToken ( const char *  value )

inline

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. If a parameter has changed, for example, the QueryString, an error is returned.

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

Definition at line 139 of file StartQueryExecutionRequest.h.

SetQueryExecutionContext() [1/2]

void Aws::Athena::Model::StartQueryExecutionRequest::SetQueryExecutionContext ( const QueryExecutionContext &  value )

inline

The database within which the query executes.

Definition at line 191 of file StartQueryExecutionRequest.h.

SetQueryExecutionContext() [2/2]

void Aws::Athena::Model::StartQueryExecutionRequest::SetQueryExecutionContext ( QueryExecutionContext &&  value )

inline

The database within which the query executes.

Definition at line 196 of file StartQueryExecutionRequest.h.

SetQueryString() [1/3]

void Aws::Athena::Model::StartQueryExecutionRequest::SetQueryString ( const Aws::String &  value )

inline

The SQL query statements to be executed.

Definition at line 53 of file StartQueryExecutionRequest.h.

SetQueryString() [2/3]

void Aws::Athena::Model::StartQueryExecutionRequest::SetQueryString ( Aws::String &&  value )

inline

The SQL query statements to be executed.

Definition at line 58 of file StartQueryExecutionRequest.h.

SetQueryString() [3/3]

void Aws::Athena::Model::StartQueryExecutionRequest::SetQueryString ( const char *  value )

inline

The SQL query statements to be executed.

Definition at line 63 of file StartQueryExecutionRequest.h.

SetResultConfiguration() [1/2]

void Aws::Athena::Model::StartQueryExecutionRequest::SetResultConfiguration ( const ResultConfiguration &  value )

inline

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.

Definition at line 237 of file StartQueryExecutionRequest.h.

SetResultConfiguration() [2/2]

void Aws::Athena::Model::StartQueryExecutionRequest::SetResultConfiguration ( ResultConfiguration &&  value )

inline

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.

Definition at line 247 of file StartQueryExecutionRequest.h.

SetWorkGroup() [1/3]

void Aws::Athena::Model::StartQueryExecutionRequest::SetWorkGroup ( const Aws::String &  value )

inline

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

Definition at line 283 of file StartQueryExecutionRequest.h.

SetWorkGroup() [2/3]

void Aws::Athena::Model::StartQueryExecutionRequest::SetWorkGroup ( Aws::String &&  value )

inline

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

Definition at line 288 of file StartQueryExecutionRequest.h.

SetWorkGroup() [3/3]

void Aws::Athena::Model::StartQueryExecutionRequest::SetWorkGroup ( const char *  value )

inline

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

Definition at line 293 of file StartQueryExecutionRequest.h.

WithClientRequestToken() [1/3]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithClientRequestToken ( const Aws::String &  value )

inline

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. If a parameter has changed, for example, the QueryString, an error is returned.

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

Definition at line 151 of file StartQueryExecutionRequest.h.

WithClientRequestToken() [2/3]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithClientRequestToken ( Aws::String &&  value )

inline

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. If a parameter has changed, for example, the QueryString, an error is returned.

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

Definition at line 163 of file StartQueryExecutionRequest.h.

WithClientRequestToken() [3/3]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithClientRequestToken ( const char *  value )

inline

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. If a parameter has changed, for example, the QueryString, an error is returned.

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

Definition at line 175 of file StartQueryExecutionRequest.h.

WithQueryExecutionContext() [1/2]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithQueryExecutionContext ( const QueryExecutionContext &  value )

inline

The database within which the query executes.

Definition at line 201 of file StartQueryExecutionRequest.h.

WithQueryExecutionContext() [2/2]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithQueryExecutionContext ( QueryExecutionContext &&  value )

inline

The database within which the query executes.

Definition at line 206 of file StartQueryExecutionRequest.h.

WithQueryString() [1/3]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithQueryString ( const Aws::String &  value )

inline

The SQL query statements to be executed.

Definition at line 68 of file StartQueryExecutionRequest.h.

WithQueryString() [2/3]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithQueryString ( Aws::String &&  value )

inline

The SQL query statements to be executed.

Definition at line 73 of file StartQueryExecutionRequest.h.

WithQueryString() [3/3]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithQueryString ( const char *  value )

inline

The SQL query statements to be executed.

Definition at line 78 of file StartQueryExecutionRequest.h.

WithResultConfiguration() [1/2]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithResultConfiguration ( const ResultConfiguration &  value )

inline

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.

Definition at line 257 of file StartQueryExecutionRequest.h.

WithResultConfiguration() [2/2]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithResultConfiguration ( ResultConfiguration &&  value )

inline

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.

Definition at line 267 of file StartQueryExecutionRequest.h.

WithWorkGroup() [1/3]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithWorkGroup ( const Aws::String &  value )

inline

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

Definition at line 298 of file StartQueryExecutionRequest.h.

WithWorkGroup() [2/3]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithWorkGroup ( Aws::String &&  value )

inline

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

Definition at line 303 of file StartQueryExecutionRequest.h.

WithWorkGroup() [3/3]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithWorkGroup ( const char *  value )

inline

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

Definition at line 308 of file StartQueryExecutionRequest.h.

WorkGroupHasBeenSet()

bool Aws::Athena::Model::StartQueryExecutionRequest::WorkGroupHasBeenSet ( ) const

inline

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

Definition at line 278 of file StartQueryExecutionRequest.h.

---

The documentation for this class was generated from the following file:

• aws-cpp-sdk-athena/include/aws/athena/model/StartQueryExecutionRequest.h