Skip to content

Session

Source code in docs_src/capo_emr/types/session.py
class Session(TypedDict, closed=True):
    id: NotRequired["capo_emr.types.session_id.SessionId"]
    """<p>The ID of the session.</p>"""
    cluster_id: NotRequired["capo_emr.types.cluster_id.ClusterId"]
    """<p>The ID of the cluster that the session belongs to.</p>"""
    name: NotRequired["capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"]
    """<p>The name of the session, if one was provided at creation time.</p>"""
    arn: NotRequired["capo_emr.types.arn_type.ArnType"]
    """<p>The Amazon Resource Name (ARN) of the session.</p>"""
    state: NotRequired["capo_emr.types.session_state.SessionState"]
    """<p>The current state of the session. Valid values are <code>SUBMITTED</code>, <code>STARTING</code>, <code>STARTED</code>, <code>IDLE</code>, <code>BUSY</code>, <code>TERMINATING</code>, <code>TERMINATED</code>, and <code>FAILED</code>.</p>"""
    state_change_reason: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>A human-readable message describing the most recent state change.</p>"""
    release_label: NotRequired[
        "capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"
    ]
    """<p>The Amazon EMR release label of the cluster that the session is running on.</p>"""
    execution_role_arn: NotRequired["capo_emr.types.iam_role_arn.IAMRoleArn"]
    """<p>The execution role ARN for the session. Amazon EMR uses this role to access Amazon Web Services resources on your behalf during session execution.</p>"""
    account_id: NotRequired["capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"]
    """<p>The Amazon Web Services account ID that owns the session.</p>"""
    created_at: NotRequired["capo_emr.types.date.Date"]
    """<p>The date and time that the session was created.</p>"""
    updated_at: NotRequired["capo_emr.types.date.Date"]
    """<p>The date and time that the session was last updated.</p>"""
    started_at: NotRequired["capo_emr.types.date.Date"]
    """<p>The date and time that the session entered the <code>STARTED</code> state.</p>"""
    ended_at: NotRequired["capo_emr.types.date.Date"]
    """<p>The date and time that the session was terminated or failed.</p>"""
    idle_since: NotRequired["capo_emr.types.date.Date"]
    """<p>The date and time that the session last entered the <code>IDLE</code> state.</p>"""
    engine_configurations: NotRequired[
        "capo_emr.types.configuration_list.ConfigurationList"
    ]
    """<p>The configuration overrides for the session. Only runtime configuration overrides are supported.</p>"""
    monitoring_configuration: NotRequired[
        "capo_emr.types.session_monitoring_configuration.SessionMonitoringConfiguration"
    ]
    """<p>The monitoring configuration for the session.</p>"""
    session_idle_timeout_in_minutes: NotRequired["capo_emr.types.long.Long"]
    """<p>The idle timeout, in minutes. If the session is idle for this duration, Amazon EMR automatically terminates it.</p>"""
    server_url: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>The Spark Connect server URL for the session. Use this URL with the <code>Credentials</code> returned by <code>GetSessionEndpoint</code> to connect directly to the session over VPC peering.</p>"""
    tags: NotRequired["capo_emr.types.tag_list.TagList"]
    """<p>The tags associated with the session.</p>"""

account_id instance-attribute

account_id: NotRequired[XmlStringMaxLen256]

The Amazon Web Services account ID that owns the session.

arn instance-attribute

arn: NotRequired[ArnType]

The Amazon Resource Name (ARN) of the session.

cluster_id instance-attribute

cluster_id: NotRequired[ClusterId]

The ID of the cluster that the session belongs to.

created_at instance-attribute

created_at: NotRequired[Date]

The date and time that the session was created.

ended_at instance-attribute

ended_at: NotRequired[Date]

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

engine_configurations instance-attribute

engine_configurations: NotRequired[ConfigurationList]

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

execution_role_arn instance-attribute

execution_role_arn: NotRequired[IAMRoleArn]

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

id instance-attribute

id: NotRequired[SessionId]

The ID of the session.

idle_since instance-attribute

idle_since: NotRequired[Date]

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

monitoring_configuration instance-attribute

monitoring_configuration: NotRequired[SessionMonitoringConfiguration]

The monitoring configuration for the session.

name instance-attribute

name: NotRequired[XmlStringMaxLen256]

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

release_label instance-attribute

release_label: NotRequired[XmlStringMaxLen256]

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

server_url instance-attribute

server_url: NotRequired[XmlString]

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.

session_idle_timeout_in_minutes instance-attribute

session_idle_timeout_in_minutes: NotRequired[Long]

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

started_at instance-attribute

started_at: NotRequired[Date]

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

state instance-attribute

state: NotRequired[SessionState]

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

state_change_reason instance-attribute

state_change_reason: NotRequired[XmlString]

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

tags instance-attribute

tags: NotRequired[TagList]

The tags associated with the session.

updated_at instance-attribute

updated_at: NotRequired[Date]

The date and time that the session was last updated.