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

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

Overview

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


4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
# File 'lib/aws-sdk-athena/types.rb', line 4363

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

#descriptionString

The session description.

Returns:

  • (String)


4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
# File 'lib/aws-sdk-athena/types.rb', line 4363

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_configurationTypes::EngineConfiguration

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



4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
# File 'lib/aws-sdk-athena/types.rb', line 4363

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_versionString

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)


4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
# File 'lib/aws-sdk-athena/types.rb', line 4363

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_minutesInteger

The idle timeout in minutes for the session.

Returns:

  • (Integer)


4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
# File 'lib/aws-sdk-athena/types.rb', line 4363

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_groupString

The workgroup to which the session belongs.

Returns:

  • (String)


4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
# File 'lib/aws-sdk-athena/types.rb', line 4363

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