EMRServerless / Client / get_session

get_session

EMRServerless.Client.get_session(**kwargs)

Displays detailed information about a session.

See also: AWS API Documentation

Request Syntax

response = client.get_session(
    applicationId='string',
    sessionId='string'
)

Parameters:

• applicationId (string) –

  [REQUIRED]

  The ID of the application that the session belongs to.

• sessionId (string) –

  [REQUIRED]

  The ID of the session.

Return type:

dict

Returns:

Response Syntax

{
    'session': {
        'applicationId': 'string',
        'sessionId': 'string',
        'arn': 'string',
        'name': 'string',
        'state': 'SUBMITTED'|'STARTING'|'STARTED'|'IDLE'|'BUSY'|'FAILED'|'TERMINATING'|'TERMINATED',
        'stateDetails': 'string',
        'releaseLabel': 'string',
        'executionRoleArn': 'string',
        'createdBy': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'startedAt': datetime(2015, 1, 1),
        'endedAt': datetime(2015, 1, 1),
        'idleSince': datetime(2015, 1, 1),
        'configurationOverrides': {
            'runtimeConfiguration': [
                {
                    'classification': 'string',
                    'properties': {
                        'string': 'string'
                    },
                    'configurations': {'... recursive ...'}
                },
            ]
        },
        'networkConfiguration': {
            'subnetIds': [
                'string',
            ],
            'securityGroupIds': [
                'string',
            ]
        },
        'idleTimeoutMinutes': 123,
        'tags': {
            'string': 'string'
        },
        'totalResourceUtilization': {
            'vCPUHour': 123.0,
            'memoryGBHour': 123.0,
            'storageGBHour': 123.0
        },
        'billedResourceUtilization': {
            'vCPUHour': 123.0,
            'memoryGBHour': 123.0,
            'storageGBHour': 123.0
        },
        'totalExecutionDurationSeconds': 123
    }
}

Response Structure

• (dict) –

  • session (dict) –

    The output displays information about the session.

    • applicationId (string) –

      The ID of the application that the session belongs to.

    • sessionId (string) –

      The ID of the session.

    • arn (string) –

      The Amazon Resource Name (ARN) of the session.

    • name (string) –

      The optional name of the session.

    • state (string) –

      The state of the session.

    • stateDetails (string) –

      Additional details about the current state of the session.

    • releaseLabel (string) –

      The Amazon EMR release label associated with the session.

    • executionRoleArn (string) –

      The Amazon Resource Name (ARN) of the execution role for the session.

    • createdBy (string) –

      The IAM principal that created the session.

    • createdAt (datetime) –

      The date and time that the session was created.

    • updatedAt (datetime) –

      The date and time that the session was last updated.

    • startedAt (datetime) –

      The date and time that the session moved to a running state.

    • endedAt (datetime) –

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

    • idleSince (datetime) –

      The date and time that the session became idle.

    • configurationOverrides (dict) –

      The configuration overrides for the session, including runtime configuration properties.

      • runtimeConfiguration (list) –

        The runtime configuration for the session. Contains Spark configuration properties specified at session creation time.

        • (dict) –

          A configuration specification to be used when provisioning an application. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file.

          • classification (string) –

            The classification within a configuration.

          • properties (dict) –

            A set of properties specified within a configuration classification.

            • (string) –

              • (string) –

          • configurations (list) –

            A list of additional configurations to apply within a configuration object.

    • networkConfiguration (dict) –

      The network configuration for customer VPC connectivity for the session.

      • subnetIds (list) –

        The array of subnet Ids for customer VPC connectivity.

        • (string) –

      • securityGroupIds (list) –

        The array of security group Ids for customer VPC connectivity.

        • (string) –

    • idleTimeoutMinutes (integer) –

      The idle timeout in minutes for the session. After the session remains idle for this duration, it is automatically terminated.

    • tags (dict) –

      The tags assigned to the session.

      • (string) –

        • (string) –

    • totalResourceUtilization (dict) –

      The aggregate vCPU, memory, and storage resources used from the time the session starts to execute, until the time the session terminates, rounded up to the nearest second.

      • vCPUHour (float) –

        The aggregated vCPU used per hour from the time job start executing till the time job is terminated.

      • memoryGBHour (float) –

        The aggregated memory used per hour from the time job start executing till the time job is terminated.

      • storageGBHour (float) –

        The aggregated storage used per hour from the time job start executing till the time job is terminated.

    • billedResourceUtilization (dict) –

      The aggregate vCPU, memory, and storage that Amazon Web Services has billed for the session. The billed resources include a 1-minute minimum usage for workers, plus additional storage over 20 GB per worker. Note that billed resources do not include usage for idle pre-initialized workers.

      • vCPUHour (float) –

        The aggregated vCPU used per hour from the time the job starts executing until the job is terminated.

      • memoryGBHour (float) –

        The aggregated memory used per hour from the time the job starts executing until the job is terminated.

      • storageGBHour (float) –

        The aggregated storage used per hour from the time the job starts executing until the job is terminated.

    • totalExecutionDurationSeconds (integer) –

      The total execution duration of the session in seconds.

Exceptions

• EMRServerless.Client.exceptions.ValidationException

• EMRServerless.Client.exceptions.InternalServerException

• EMRServerless.Client.exceptions.ResourceNotFoundException