Session - AWS Glue

Session

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

Contents

Command

The command object.See SessionCommand.

Type: SessionCommand object

Required: No

CompletedOn

The date and time that this session is completed.

Type: Timestamp

Required: No

Connections

The number of connections used for the session.

Type: ConnectionsList object

Required: No

CreatedOn

The time and date when the session was created.

Type: Timestamp

Required: No

DefaultArguments

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

Type: String to string map

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

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

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

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

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

Required: No

Description

The description of the session.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

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

Required: No

DPUSeconds

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

Type: Double

Required: No

ErrorMessage

The error message displayed during the session.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

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

Required: No

ExecutionTime

The total time the session ran for.

Type: Double

Required: No

GlueVersion

The AWS Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The GlueVersion must be greater than 2.0.

Type: String

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

Pattern: ^(\w+\.)+\w+$

Required: No

Id

The ID of the session.

Type: String

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

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

Required: No

IdleTimeout

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

Type: Integer

Required: No

MaxCapacity

The number of AWS 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.

Type: Double

Required: No

NumberOfWorkers

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

Type: Integer

Required: No

ProfileName

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

Type: String

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

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

Required: No

Progress

The code execution progress of the session.

Type: Double

Required: No

Role

The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[^:]*:iam::[0-9]*:role/.+

Required: No

SecurityConfiguration

The name of the SecurityConfiguration structure to be used with the session.

Type: String

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

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

Required: No

Status

The session status.

Type: String

Valid Values: PROVISIONING | READY | FAILED | TIMEOUT | STOPPING | STOPPED

Required: No

WorkerType

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.

Type: String

Valid Values: Standard | G.1X | G.2X | G.025X | G.4X | G.8X | Z.2X

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: