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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb

Overview

Note:

When making an API call, you may pass StartQueryExecutionInput data as a hash:

{
  query_string: "QueryString", # required
  client_request_token: "IdempotencyToken",
  query_execution_context: {
    database: "DatabaseString",
    catalog: "CatalogNameString",
  },
  result_configuration: {
    output_location: "String",
    encryption_configuration: {
      encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
      kms_key: "String",
    },
  },
  work_group: "WorkGroupName",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

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 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)


2158
2159
2160
2161
2162
2163
2164
2165
2166
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2158

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

#query_execution_contextTypes::QueryExecutionContext

The database within which the query executes.



2158
2159
2160
2161
2162
2163
2164
2165
2166
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2158

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

#query_stringString

The SQL query statements to be executed.

Returns:

  • (String)


2158
2159
2160
2161
2162
2163
2164
2165
2166
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2158

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

#result_configurationTypes::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.



2158
2159
2160
2161
2162
2163
2164
2165
2166
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2158

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

#work_groupString

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

Returns:

  • (String)


2158
2159
2160
2161
2162
2163
2164
2165
2166
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2158

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