Class: Aws::Athena::Types::CreateNamedQueryInput

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

Overview

Note:

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

{
  name: "NameString", # required
  description: "DescriptionString",
  database: "DatabaseString", # required
  query_string: "QueryString", # required
  client_request_token: "IdempotencyToken",
}

See Also:

Instance Attribute Summary collapse

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 ‘CreateNamedQuery` 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.

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

Returns:

  • (String) 


184
185
186
187
188
189
190
191
 
# File 'lib/aws-sdk-athena/types.rb', line 184

class CreateNamedQueryInput < Struct.new(
  :name,
  :description,
  :database,
  :query_string,
  :client_request_token)
  include Aws::Structure
end

#database ⇒ String

The database to which the query belongs.

Returns:

  • (String) 


184
185
186
187
188
189
190
191
 
# File 'lib/aws-sdk-athena/types.rb', line 184

class CreateNamedQueryInput < Struct.new(
  :name,
  :description,
  :database,
  :query_string,
  :client_request_token)
  include Aws::Structure
end

#description ⇒ String

A brief explanation of the query.

Returns:

  • (String) 


184
185
186
187
188
189
190
191
 
# File 'lib/aws-sdk-athena/types.rb', line 184

class CreateNamedQueryInput < Struct.new(
  :name,
  :description,
  :database,
  :query_string,
  :client_request_token)
  include Aws::Structure
end

#name ⇒ String

The plain language name for the query.

Returns:

  • (String) 


184
185
186
187
188
189
190
191
 
# File 'lib/aws-sdk-athena/types.rb', line 184

class CreateNamedQueryInput < Struct.new(
  :name,
  :description,
  :database,
  :query_string,
  :client_request_token)
  include Aws::Structure
end

#query_string ⇒ String

The text of the query itself. In other words, all query statements.

Returns:

  • (String) 


184
185
186
187
188
189
190
191
 
# File 'lib/aws-sdk-athena/types.rb', line 184

class CreateNamedQueryInput < Struct.new(
  :name,
  :description,
  :database,
  :query_string,
  :client_request_token)
  include Aws::Structure
end