EMRServerless / Client / get_job_run

get_job_run#

EMRServerless.Client.get_job_run(**kwargs)#

Displays detailed information about a job run.

Request Syntax

response = client.get_job_run(
    applicationId='string',
    jobRunId='string'
)

Parameters:

applicationId (string) –
[REQUIRED]

The ID of the application on which the job run is submitted.
jobRunId (string) –
[REQUIRED]

The ID of the job run.

Return type:

dict

Returns:

Response Syntax

{
    'jobRun': {
        'applicationId': 'string',
        'jobRunId': 'string',
        'name': 'string',
        'arn': 'string',
        'createdBy': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'executionRole': 'string',
        'state': 'SUBMITTED'|'PENDING'|'SCHEDULED'|'RUNNING'|'SUCCESS'|'FAILED'|'CANCELLING'|'CANCELLED',
        'stateDetails': 'string',
        'releaseLabel': 'string',
        'configurationOverrides': {
            'applicationConfiguration': [
                {
                    'classification': 'string',
                    'properties': {
                        'string': 'string'
                    },
                    'configurations': {'... recursive ...'}
                },
            ],
            'monitoringConfiguration': {
                's3MonitoringConfiguration': {
                    'logUri': 'string',
                    'encryptionKeyArn': 'string'
                },
                'managedPersistenceMonitoringConfiguration': {
                    'enabled': True|False,
                    'encryptionKeyArn': 'string'
                }
            }
        },
        'jobDriver': {
            'sparkSubmit': {
                'entryPoint': 'string',
                'entryPointArguments': [
                    'string',
                ],
                'sparkSubmitParameters': 'string'
            },
            'hive': {
                'query': 'string',
                'initQueryFile': 'string',
                'parameters': 'string'
            }
        },
        'tags': {
            'string': 'string'
        },
        'totalResourceUtilization': {
            'vCPUHour': 123.0,
            'memoryGBHour': 123.0,
            'storageGBHour': 123.0
        },
        'networkConfiguration': {
            'subnetIds': [
                'string',
            ],
            'securityGroupIds': [
                'string',
            ]
        },
        'totalExecutionDurationSeconds': 123,
        'executionTimeoutMinutes': 123,
        'billedResourceUtilization': {
            'vCPUHour': 123.0,
            'memoryGBHour': 123.0,
            'storageGBHour': 123.0
        }
    }
}

Response Structure

(dict) –
- jobRun (dict) –
  
  The output displays information about the job run.
  - applicationId (string) –
    
    The ID of the application the job is running on.
  - jobRunId (string) –
    
    The ID of the job run.
  - name (string) –
    
    The optional job run name. This doesn’t have to be unique.
  - arn (string) –
    
    The execution role ARN of the job run.
  - createdBy (string) –
    
    The user who created the job run.
  - createdAt (datetime) –
    
    The date and time when the job run was created.
  - updatedAt (datetime) –
    
    The date and time when the job run was updated.
  - executionRole (string) –
    
    The execution role ARN of the job run.
  - state (string) –
    
    The state of the job run.
  - stateDetails (string) –
    
    The state details of the job run.
  - releaseLabel (string) –
    
    The EMR release associated with the application your job is running on.
  - configurationOverrides (dict) –
    
    The configuration settings that are used to override default configuration.
    - applicationConfiguration (list) –
      
      The override configurations for the application.
      - (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.
    - monitoringConfiguration (dict) –
      
      The override configurations for monitoring.
      - s3MonitoringConfiguration (dict) –
        
        The Amazon S3 configuration for monitoring log publishing.
        
        logUri (string) –
        
        The Amazon S3 destination URI for log publishing.
        
        encryptionKeyArn (string) –
        
        The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.
      - managedPersistenceMonitoringConfiguration (dict) –
        
        The managed log persistence configuration for a job run.
        
        enabled (boolean) –
        
        Enables managed logging and defaults to true. If set to false, managed logging will be turned off.
        
        encryptionKeyArn (string) –
        
        The KMS key ARN to encrypt the logs stored in managed log persistence.
  - jobDriver (dict) –
    
    The job driver for the job run.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: sparkSubmit, hive. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    - sparkSubmit (dict) –
      
      The job driver parameters specified for Spark.
      - entryPoint (string) –
        
        The entry point for the Spark submit job run.
      - entryPointArguments (list) –
        
        The arguments for the Spark submit job run.
        
        (string) –
      - sparkSubmitParameters (string) –
        
        The parameters for the Spark submit job run.
    - hive (dict) –
      
      The job driver parameters specified for Hive.
      - query (string) –
        
        The query for the Hive job run.
      - initQueryFile (string) –
        
        The query file for the Hive job run.
      - parameters (string) –
        
        The parameters for the Hive job run.
  - tags (dict) –
    
    The tags assigned to the job run.
    - (string) –
      - (string) –
  - totalResourceUtilization (dict) –
    
    The aggregate vCPU, memory, and storage resources used from the time the job starts to execute, until the time the job 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.
  - networkConfiguration (dict) –
    
    The network configuration for customer VPC connectivity.
    - 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) –
  - totalExecutionDurationSeconds (integer) –
    
    The job run total execution duration in seconds. This field is only available for job runs in a COMPLETED, FAILED, or CANCELLED state.
  - executionTimeoutMinutes (integer) –
    
    Returns the job run timeout value from the StartJobRun call. If no timeout was specified, then it returns the default timeout of 720 minutes.
  - billedResourceUtilization (dict) –
    
    The aggregate vCPU, memory, and storage that AWS has billed for the job run. 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.

Exceptions

EMRServerless.Client.exceptions.ValidationException
EMRServerless.Client.exceptions.ResourceNotFoundException
EMRServerless.Client.exceptions.InternalServerException