list-sessions¶
Description¶
Retrieve a list of sessions.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
list-sessions
[--next-token <value>]
[--max-results <value>]
[--tags <value>]
[--request-origin <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--next-token (string)
The token for the next set of results, or null if there are no more result.
--max-results (integer)
The maximum number of results.
--tags (map)
Tags belonging to the session.
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--request-origin (string)
The origin of the request.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Output¶
Ids -> (list)
Returns the ID of the session.
(string)
Sessions -> (list)
Returns the session object.
(structure)
The period in which a remote Spark runtime environment is running.
Id -> (string)
The ID of the session.
CreatedOn -> (timestamp)
The time and date when the session was created.
Status -> (string)
The session status.
ErrorMessage -> (string)
The error message displayed during the session.
Description -> (string)
The description of the session.
Role -> (string)
The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.
Command -> (structure)
The command object.See SessionCommand.
Name -> (string)
Specifies the name of the SessionCommand. Can be ‘glueetl’ or ‘gluestreaming’.
PythonVersion -> (string)
Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.
DefaultArguments -> (map)
A map array of key-value pairs. Max is 75 pairs.
key -> (string)
value -> (string)
Connections -> (structure)
The number of connections used for the session.
Connections -> (list)
A list of connections used by the job.
(string)
Progress -> (double)
The code execution progress of the session.
MaxCapacity -> (double)
The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
SecurityConfiguration -> (string)
The name of the SecurityConfiguration structure to be used with the session.
GlueVersion -> (string)
The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
NextToken -> (string)
The token for the next set of results, or null if there are no more result.