Session - Amazon EMR
ContentsSee Also
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

Session

Detailed information about a Spark Connect session.

Contents

Arn

The Amazon Resource Name (ARN) of the session.

Type: String

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

Required: Yes

ClusterId

The ID of the cluster that the session belongs to.

Type: String

Length Constraints: Maximum length of 256.

Required: Yes

Id

The ID of the session.

Type: String

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

Required: Yes

State

The current state of the session. Valid values are SUBMITTED, STARTING, STARTED, IDLE, BUSY, TERMINATING, TERMINATED, and FAILED.

Type: String

Valid Values: SUBMITTED | STARTING | STARTED | IDLE | BUSY | TERMINATING | TERMINATED | FAILED

Required: Yes

AccountId

The AWS account ID that owns the session.

Type: String

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

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

Required: No

CreatedAt

The date and time that the session was created.

Type: Timestamp

Required: No

EndedAt

The date and time that the session was terminated or failed.

Type: Timestamp

Required: No

EngineConfigurations

The configuration overrides for the session. Only runtime configuration overrides are supported.

Type: Array of Configuration objects

Required: No

ExecutionRoleArn

The execution role ARN for the session. Amazon EMR uses this role to access AWS resources on your behalf during session execution.

Type: String

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

Pattern: ^arn:(aws[a-zA-Z0-9-]*):iam::(\d{12})?:(role((\u002F)|(\u002F[\u0021-\u007F]+\u002F))[\w+=,.@-]+)$

Required: No

IdleSince

The date and time that the session last entered the IDLE state.

Type: Timestamp

Required: No

MonitoringConfiguration

The monitoring configuration for the session.

Type: SessionMonitoringConfiguration object

Required: No

Name

The name of the session, if one was provided at creation time.

Type: String

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

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

Required: No

ReleaseLabel

The Amazon EMR release label of the cluster that the session is running on.

Type: String

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

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

Required: No

ServerUrl

The Spark Connect server URL for the session. Use this URL with the Credentials returned by GetSessionEndpoint to connect directly to the session over VPC peering.

Type: String

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

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

Required: No

SessionIdleTimeoutInMinutes

The idle timeout, in minutes. If the session is idle for this duration, Amazon EMR automatically terminates it.

Type: Long

Required: No

StartedAt

The date and time that the session entered the STARTED state.

Type: Timestamp

Required: No

StateChangeReason

A human-readable message describing the most recent state change.

Type: String

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

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

Required: No

Tags

The tags associated with the session.

Type: Array of Tag objects

Required: No

UpdatedAt

The date and time that the session was last updated.

Type: Timestamp

Required: No

See Also

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