Skip to content

Start Session

athena_start_session R Documentation

Creates a session for running calculations within a workgroup

Description

Creates a session for running calculations within a workgroup. The session is ready when it reaches an IDLE state.

Usage

athena_start_session(Description, WorkGroup, EngineConfiguration,
  ExecutionRole, MonitoringConfiguration, NotebookVersion,
  SessionIdleTimeoutInMinutes, ClientRequestToken, Tags,
  CopyWorkGroupTags)

Arguments

Description

The session description.
WorkGroup

[required] The workgroup to which the session belongs.
EngineConfiguration

[required] Contains engine data processing unit (DPU) configuration settings and parameter mappings.
ExecutionRole

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.
MonitoringConfiguration

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

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.
SessionIdleTimeoutInMinutes

The idle timeout in minutes for the session.
ClientRequestToken

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.
Tags

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

Copies the tags from the Workgroup to the Session when.

Value

A list with the following syntax:

list(
  SessionId = "string",
  State = "CREATING"|"CREATED"|"IDLE"|"BUSY"|"TERMINATING"|"TERMINATED"|"DEGRADED"|"FAILED"
)

Request syntax

svc$start_session(
  Description = "string",
  WorkGroup = "string",
  EngineConfiguration = list(
    CoordinatorDpuSize = 123,
    MaxConcurrentDpus = 123,
    DefaultExecutorDpuSize = 123,
    AdditionalConfigs = list(
      "string"
    ),
    SparkProperties = list(
      "string"
    ),
    Classifications = list(
      list(
        Name = "string",
        Properties = list(
          "string"
        )
      )
    )
  ),
  ExecutionRole = "string",
  MonitoringConfiguration = list(
    CloudWatchLoggingConfiguration = list(
      Enabled = TRUE|FALSE,
      LogGroup = "string",
      LogStreamNamePrefix = "string",
      LogTypes = list(
        list(
          "string"
        )
      )
    ),
    ManagedLoggingConfiguration = list(
      Enabled = TRUE|FALSE,
      KmsKey = "string"
    ),
    S3LoggingConfiguration = list(
      Enabled = TRUE|FALSE,
      KmsKey = "string",
      LogLocation = "string"
    )
  ),
  NotebookVersion = "string",
  SessionIdleTimeoutInMinutes = 123,
  ClientRequestToken = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  CopyWorkGroupTags = TRUE|FALSE
)