Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListSessions

Lists the sessions in a workgroup that are in an active state like CREATING, CREATED, IDLE, or BUSY. Newer sessions are listed first; older sessions are listed later.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "StateFilter": "string",
   "WorkGroup": "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.

MaxResults

The maximum number of sessions to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Type: String

Length Constraints: Maximum length of 2048.

Required: No

StateFilter

A filter for a specific session state. 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.

Type: String

Required: No

WorkGroup

The workgroup to which the session belongs.

Type: String

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

Required: Yes

Response Syntax


{
   "NextToken": "string",
   "Sessions": [ 
      { 
         "Description": "string",
         "EngineVersion": { 
            "EffectiveEngineVersion": "string",
            "SelectedEngineVersion": "string"
         },
         "NotebookVersion": "string",
         "SessionId": "string",
         "Status": { 
            "EndDateTime": number,
            "IdleSinceDateTime": number,
            "LastModifiedDateTime": number,
            "StartDateTime": number,
            "State": "string",
            "StateChangeReason": "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.

NextToken

Type: String

Length Constraints: Maximum length of 2048.

Sessions

A list of sessions.

Type: Array of SessionSummary objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

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