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'
        },
    ],
    '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.

  • NextToken (string) --

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

Exceptions

• Glue.Client.exceptions.AccessDeniedException
• Glue.Client.exceptions.InvalidInputException
• Glue.Client.exceptions.InternalServiceException
• Glue.Client.exceptions.OperationTimeoutException