/AWS1/CL_ATH=>STARTSESSION()

About StartSession

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

Method Signature

IMPORTING

Required arguments:

IV_WORKGROUP TYPE /AWS1/ATHWORKGROUPNAME /AWS1/ATHWORKGROUPNAME

The workgroup to which the session belongs.

IO_ENGINECONFIGURATION TYPE REF TO /AWS1/CL_ATHENGINECONF /AWS1/CL_ATHENGINECONF

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

Optional arguments:

IV_DESCRIPTION TYPE /AWS1/ATHDESCRIPTIONSTRING /AWS1/ATHDESCRIPTIONSTRING

The session description.

IV_NOTEBOOKVERSION TYPE /AWS1/ATHNAMESTRING /AWS1/ATHNAMESTRING

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.

IV_SESSIDLETIMEOUTINMINUTES TYPE /AWS1/ATHSESSIDLETMOUTINMINS /AWS1/ATHSESSIDLETMOUTINMINS

The idle timeout in minutes for the session.

IV_CLIENTREQUESTTOKEN TYPE /AWS1/ATHIDEMPOTENCYTOKEN /AWS1/ATHIDEMPOTENCYTOKEN

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.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_ATHSTARTSESSIONRSP /AWS1/CL_ATHSTARTSESSIONRSP