GetSession - Athena

GetSession

Gets the full details of a previously created session, including the session status and configuration.

Request Syntax

{ "SessionId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

SessionId

The session ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Response Syntax

{ "Description": "string", "EngineConfiguration": { "AdditionalConfigs": { "string" : "string" }, "CoordinatorDpuSize": number, "DefaultExecutorDpuSize": number, "MaxConcurrentDpus": number }, "EngineVersion": "string", "NotebookVersion": "string", "SessionConfiguration": { "EncryptionConfiguration": { "EncryptionOption": "string", "KmsKey": "string" }, "ExecutionRole": "string", "IdleTimeoutSeconds": number, "WorkingDirectory": "string" }, "SessionId": "string", "Statistics": { "DpuExecutionInMillis": number }, "Status": { "EndDateTime": number, "IdleSinceDateTime": number, "LastModifiedDateTime": number, "StartDateTime": number, "State": "string", "StateChangeReason": "string" }, "WorkGroup": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Description

The session description.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

EngineConfiguration

Contains engine configuration information like DPU usage.

Type: EngineConfiguration object

EngineVersion

The engine version used by the session (for example, PySpark engine version 3). You can get a list of engine versions by calling ListEngineVersions.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

NotebookVersion

The notebook version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

SessionConfiguration

Contains the workgroup configuration information used by the session.

Type: SessionConfiguration object

SessionId

The session ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Statistics

Contains the DPU execution time.

Type: SessionStatistics object

Status

Contains information about the status of the session.

Type: SessionStatus object

WorkGroup

The workgroup to which the session belongs.

Type: String

Pattern: [a-zA-Z0-9._-]{1,128}

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

Indicates a platform issue, which may be due to a transient condition or outage.

HTTP Status Code: 500

InvalidRequestException

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

HTTP Status Code: 400

ResourceNotFoundException

A resource, such as a workgroup, was not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: