Class: Aws::Athena::Types::StartQueryExecutionInput

Inherits:

Struct

• Object
• Struct
• Aws::Athena::Types::StartQueryExecutionInput

Defined in:

gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_request_token ⇒ String

  A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once).

• #execution_parameters ⇒ Array<String>

  A list of values for the parameters in a query.

• #query_execution_context ⇒ Types::QueryExecutionContext

  The database within which the query executes.

• #query_string ⇒ String

  The SQL query statements to be executed.

• #result_configuration ⇒ Types::ResultConfiguration

  Specifies information about where and how to save the results of the query execution.

• #result_reuse_configuration ⇒ Types::ResultReuseConfiguration

  Specifies the query result reuse behavior for the query.

• #work_group ⇒ String

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

Instance Attribute Details

#client_request_token ⇒ String

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.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4100

class StartQueryExecutionInput < Struct.new(
  :query_string,
  :client_request_token,
  :query_execution_context,
  :result_configuration,
  :work_group,
  :execution_parameters,
  :result_reuse_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#execution_parameters ⇒ Array<String>

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.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4100

class StartQueryExecutionInput < Struct.new(
  :query_string,
  :client_request_token,
  :query_execution_context,
  :result_configuration,
  :work_group,
  :execution_parameters,
  :result_reuse_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#query_execution_context ⇒ Types::QueryExecutionContext

The database within which the query executes.

Returns:

• (Types::QueryExecutionContext)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4100

class StartQueryExecutionInput < Struct.new(
  :query_string,
  :client_request_token,
  :query_execution_context,
  :result_configuration,
  :work_group,
  :execution_parameters,
  :result_reuse_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#query_string ⇒ String

The SQL query statements to be executed.

Returns:

• (String)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4100

class StartQueryExecutionInput < Struct.new(
  :query_string,
  :client_request_token,
  :query_execution_context,
  :result_configuration,
  :work_group,
  :execution_parameters,
  :result_reuse_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#result_configuration ⇒ Types::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.

Returns:

• (Types::ResultConfiguration)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4100

class StartQueryExecutionInput < Struct.new(
  :query_string,
  :client_request_token,
  :query_execution_context,
  :result_configuration,
  :work_group,
  :execution_parameters,
  :result_reuse_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#result_reuse_configuration ⇒ Types::ResultReuseConfiguration

Specifies the query result reuse behavior for the query.

Returns:

• (Types::ResultReuseConfiguration)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4100

class StartQueryExecutionInput < Struct.new(
  :query_string,
  :client_request_token,
  :query_execution_context,
  :result_configuration,
  :work_group,
  :execution_parameters,
  :result_reuse_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#work_group ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4100

class StartQueryExecutionInput < Struct.new(
  :query_string,
  :client_request_token,
  :query_execution_context,
  :result_configuration,
  :work_group,
  :execution_parameters,
  :result_reuse_configuration)
  SENSITIVE = []
  include Aws::Structure
end