Class: Aws::Athena::Types::StartSessionRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_token ⇒ String

A unique case-sensitive string used to ensure the request to create the session is idempotent (executes only once). If another StartSessionRequest is received, the same response is returned and another session is not created. If a parameter has changed, 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.

Returns:

  • (String) 


4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
 
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4455

class StartSessionRequest < Struct.new(
  :description,
  :work_group,
  :engine_configuration,
  :notebook_version,
  :session_idle_timeout_in_minutes,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The session description.

Returns:

  • (String) 


4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
 
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4455

class StartSessionRequest < Struct.new(
  :description,
  :work_group,
  :engine_configuration,
  :notebook_version,
  :session_idle_timeout_in_minutes,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#engine_configuration ⇒ Types::EngineConfiguration

Contains engine data processing unit (DPU) configuration settings and parameter mappings.

Returns:



4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
 
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4455

class StartSessionRequest < Struct.new(
  :description,
  :work_group,
  :engine_configuration,
  :notebook_version,
  :session_idle_timeout_in_minutes,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#notebook_version ⇒ String

The notebook version. This value is supplied automatically for notebook sessions in the Athena console and is not required for programmatic session access. The only valid notebook version is Athena notebook version 1. If you specify a value for NotebookVersion, you must also specify a value for NotebookId. See EngineConfiguration$AdditionalConfigs.

Returns:

  • (String) 


4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
 
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4455

class StartSessionRequest < Struct.new(
  :description,
  :work_group,
  :engine_configuration,
  :notebook_version,
  :session_idle_timeout_in_minutes,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#session_idle_timeout_in_minutes ⇒ Integer

The idle timeout in minutes for the session.

Returns:

  • (Integer) 


4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
 
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4455

class StartSessionRequest < Struct.new(
  :description,
  :work_group,
  :engine_configuration,
  :notebook_version,
  :session_idle_timeout_in_minutes,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#work_group ⇒ String

The workgroup to which the session belongs.

Returns:

  • (String) 


4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
 
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4455

class StartSessionRequest < Struct.new(
  :description,
  :work_group,
  :engine_configuration,
  :notebook_version,
  :session_idle_timeout_in_minutes,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end