Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListSessions

Retrieve a list of sessions.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "RequestOrigin": "string",
   "Tags": { 
      "string" : "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 results.

Type: Integer

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

Required: No

NextToken

The token for the next set of results, or null if there are no more result.

Type: String

Length Constraints: Maximum length of 400000.

Required: No

RequestOrigin

The origin of the request.

Type: String

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

Pattern: [\.\-_A-Za-z0-9]+

Required: No

Tags

Tags belonging to the session.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

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

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


{
   "Ids": [ "string" ],
   "NextToken": "string",
   "Sessions": [ 
      { 
         "Command": { 
            "Name": "string",
            "PythonVersion": "string"
         },
         "CompletedOn": number,
         "Connections": { 
            "Connections": [ "string" ]
         },
         "CreatedOn": number,
         "DefaultArguments": { 
            "string" : "string" 
         },
         "Description": "string",
         "DPUSeconds": number,
         "ErrorMessage": "string",
         "ExecutionTime": number,
         "GlueVersion": "string",
         "Id": "string",
         "IdleTimeout": number,
         "MaxCapacity": number,
         "NumberOfWorkers": number,
         "ProfileName": "string",
         "Progress": number,
         "Role": "string",
         "SecurityConfiguration": "string",
         "Status": "string",
         "WorkerType": "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.

Ids

Returns the ID of the session.

Type: Array of strings

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

NextToken

The token for the next set of results, or null if there are no more result.

Type: String

Length Constraints: Maximum length of 400000.

Sessions

Returns the session object.

Type: Array of Session objects

Errors

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

AccessDeniedException

Access to a resource was denied.

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400