Athena / Client / start_session

start_session#

Athena.Client.start_session(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.start_session(
    Description='string',
    WorkGroup='string',
    EngineConfiguration={
        'CoordinatorDpuSize': 123,
        'MaxConcurrentDpus': 123,
        'DefaultExecutorDpuSize': 123,
        'AdditionalConfigs': {
            'string': 'string'
        },
        'SparkProperties': {
            'string': 'string'
        }
    },
    NotebookVersion='string',
    SessionIdleTimeoutInMinutes=123,
    ClientRequestToken='string'
)
Parameters:

  • Description (string) – The session description.

  • WorkGroup (string) –

    [REQUIRED]

    The workgroup to which the session belongs.

  • EngineConfiguration (dict) –

    [REQUIRED]

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

    • CoordinatorDpuSize (integer) –

      The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session. The default is 1.

    • MaxConcurrentDpus (integer) – [REQUIRED]

      The maximum number of DPUs that can run concurrently.

    • DefaultExecutorDpuSize (integer) –

      The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena. The default is 1.

    • AdditionalConfigs (dict) –

      Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.

      • (string) –

        • (string) –

    • SparkProperties (dict) –

      Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.

      • (string) –

        • (string) –

  • NotebookVersion (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.

  • SessionIdleTimeoutInMinutes (integer) – The idle timeout in minutes for the session.

  • ClientRequestToken (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.

    Warning

    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.

Return type:

dict

Returns:

Response Syntax

{
    'SessionId': 'string',
    'State': 'CREATING'|'CREATED'|'IDLE'|'BUSY'|'TERMINATING'|'TERMINATED'|'DEGRADED'|'FAILED'
}

Response Structure

  • (dict) –

    • SessionId (string) –

      The session ID.

    • State (string) –

      The state of the session. A description of each state follows.

      CREATING - The session is being started, including acquiring resources.

      CREATED - The session has been started.

      IDLE - The session is able to accept a calculation.

      BUSY - The session is processing another task and is unable to accept a calculation.

      TERMINATING - The session is in the process of shutting down.

      TERMINATED - The session and its resources are no longer running.

      DEGRADED - The session has no healthy coordinators.

      FAILED - Due to a failure, the session and its resources are no longer running.

Exceptions