Glue / Client / list_sessions

list_sessions#

Glue.Client.list_sessions(**kwargs)#

Retrieve a list of sessions.

See also: AWS API Documentation

Request Syntax

response = client.list_sessions(
    NextToken='string',
    MaxResults=123,
    Tags={
        'string': 'string'
    },
    RequestOrigin='string'
)
Parameters:

  • NextToken (string) – The token for the next set of results, or null if there are no more result.

  • MaxResults (integer) – The maximum number of results.

  • Tags (dict) –

    Tags belonging to the session.

    • (string) –

      • (string) –

  • RequestOrigin (string) – The origin of the request.

Return type:

dict

Returns:

Response Syntax

{
    'Ids': [
        'string',
    ],
    'Sessions': [
        {
            'Id': 'string',
            'CreatedOn': datetime(2015, 1, 1),
            'Status': 'PROVISIONING'|'READY'|'FAILED'|'TIMEOUT'|'STOPPING'|'STOPPED',
            'ErrorMessage': 'string',
            'Description': 'string',
            'Role': 'string',
            'Command': {
                'Name': 'string',
                'PythonVersion': 'string'
            },
            'DefaultArguments': {
                'string': 'string'
            },
            'Connections': {
                'Connections': [
                    'string',
                ]
            },
            'Progress': 123.0,
            'MaxCapacity': 123.0,
            'SecurityConfiguration': 'string',
            'GlueVersion': 'string',
            'NumberOfWorkers': 123,
            'WorkerType': 'Standard'|'G.1X'|'G.2X'|'G.025X'|'G.4X'|'G.8X'|'Z.2X',
            'CompletedOn': datetime(2015, 1, 1),
            'ExecutionTime': 123.0,
            'DPUSeconds': 123.0,
            'IdleTimeout': 123,
            'ProfileName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Ids (list) –

      Returns the ID of the session.

      • (string) –

    • Sessions (list) –

      Returns the session object.

      • (dict) –

        The period in which a remote Spark runtime environment is running.

        • Id (string) –

          The ID of the session.

        • CreatedOn (datetime) –

          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 (dict) –

          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 (dict) –

          A map array of key-value pairs. Max is 75 pairs.

          • (string) –

            • (string) –

        • Connections (dict) –

          The number of connections used for the session.

          • Connections (list) –

            A list of connections used by the job.

            • (string) –

        • Progress (float) –

          The code execution progress of the session.

        • MaxCapacity (float) –

          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.

        • NumberOfWorkers (integer) –

          The number of workers of a defined WorkerType to use for the session.

        • WorkerType (string) –

          The type of predefined worker that is allocated when a session runs. Accepts a value of G.1X, G.2X, G.4X, or G.8X for Spark sessions. Accepts the value Z.2X for Ray sessions.

        • CompletedOn (datetime) –

          The date and time that this session is completed.

        • ExecutionTime (float) –

          The total time the session ran for.

        • DPUSeconds (float) –

          The DPUs consumed by the session (formula: ExecutionTime * MaxCapacity).

        • IdleTimeout (integer) –

          The number of minutes when idle before the session times out.

        • ProfileName (string) –

          The name of an Glue usage profile associated with the session.

    • NextToken (string) –

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

Exceptions