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

Inherits:

Struct

• Object
• Struct
• Aws::Athena::Types::StartSessionRequest

Defined in:

gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_request_token ⇒ String

  A unique case-sensitive string used to ensure the request to create the session is idempotent (executes only once).

• #copy_work_group_tags ⇒ Boolean

  Copies the tags from the Workgroup to the Session when.

• #description ⇒ String

  The session description.

• #engine_configuration ⇒ Types::EngineConfiguration

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

• #execution_role ⇒ String

  The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups.

• #monitoring_configuration ⇒ Types::MonitoringConfiguration

  Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

• #notebook_version ⇒ String

  The notebook version.

• #session_idle_timeout_in_minutes ⇒ Integer

  The idle timeout in minutes for the session.

• #tags ⇒ Array<Types::Tag>

  A list of comma separated tags to add to the session that is created.

• #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.

Returns:

• (String)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4687

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

#copy_work_group_tags ⇒ Boolean

Copies the tags from the Workgroup to the Session when.

Returns:

• (Boolean)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4687

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

#description ⇒ String

The session description.

Returns:

• (String)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4687

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

#engine_configuration ⇒ Types::EngineConfiguration

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

Returns:

• (Types::EngineConfiguration)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4687

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

#execution_role ⇒ String

The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.

Returns:

• (String)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4687

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

#monitoring_configuration ⇒ Types::MonitoringConfiguration

Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

Returns:

• (Types::MonitoringConfiguration)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4687

class StartSessionRequest < Struct.new(
  :description,
  :work_group,
  :engine_configuration,
  :execution_role,
  :monitoring_configuration,
  :notebook_version,
  :session_idle_timeout_in_minutes,
  :client_request_token,
  :tags,
  :copy_work_group_tags)
  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)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4687

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

#session_idle_timeout_in_minutes ⇒ Integer

The idle timeout in minutes for the session.

Returns:

• (Integer)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4687

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

#tags ⇒ Array<Types::Tag>

A list of comma separated tags to add to the session that is created.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4687

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

#work_group ⇒ String

The workgroup to which the session belongs.

Returns:

• (String)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 4687

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