Class: Aws::Athena::Types::StartSessionRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Athena::Types::StartSessionRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-athena/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#client_request_token ⇒ String
A unique case-sensitive string used to ensure the request to create the session is idempotent (executes only once).
-
#description ⇒ String
The session description.
-
#engine_configuration ⇒ Types::EngineConfiguration
Contains engine data processing unit (DPU) configuration settings and parameter mappings.
-
#notebook_version ⇒ String
The notebook version.
-
#session_idle_timeout_in_minutes ⇒ Integer
The idle timeout in minutes for the session.
-
#work_group ⇒ String
The workgroup to which the session belongs.
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.
4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 |
# File 'lib/aws-sdk-athena/types.rb', line 4178 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.
4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 |
# File 'lib/aws-sdk-athena/types.rb', line 4178 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.
4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 |
# File 'lib/aws-sdk-athena/types.rb', line 4178 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.
4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 |
# File 'lib/aws-sdk-athena/types.rb', line 4178 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.
4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 |
# File 'lib/aws-sdk-athena/types.rb', line 4178 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.
4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 |
# File 'lib/aws-sdk-athena/types.rb', line 4178 class StartSessionRequest < Struct.new( :description, :work_group, :engine_configuration, :notebook_version, :session_idle_timeout_in_minutes, :client_request_token) SENSITIVE = [] include Aws::Structure end |