AWS API Changes

2023/07/25 - EMR Serverless - 2 updated api methods

Changes This release adds support for publishing application logs to CloudWatch.

GetJobRun (updated)

Link ¶
Changes (response)

{'jobRun': {'configurationOverrides': {'monitoringConfiguration': {'cloudWatchLoggingConfiguration': {'enabled': 'boolean',
                                                                                                      'encryptionKeyArn': 'string',
                                                                                                      'logGroupName': 'string',
                                                                                                      'logStreamNamePrefix': 'string',
                                                                                                      'logTypes': {'string': ['string']}}}}}}

Displays detailed information about a job run.

See also: AWS API Documentation

Request Syntax

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

type applicationId:

string

param applicationId:

[REQUIRED]

The ID of the application on which the job run is submitted.

type jobRunId:

string

param jobRunId:

[REQUIRED]

The ID of the job run.

rtype:

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'
                },
                'cloudWatchLoggingConfiguration': {
                    'enabled': True|False,
                    'logGroupName': 'string',
                    'logStreamNamePrefix': 'string',
                    'encryptionKeyArn': 'string',
                    'logTypes': {
                        'string': [
                            '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 Amazon 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.
      - cloudWatchLoggingConfiguration (dict) --
        
        The Amazon CloudWatch configuration for monitoring logs. You can configure your jobs to send log information to CloudWatch.
        
        enabled (boolean) --
        
        Enables CloudWatch logging.
        
        logGroupName (string) --
        
        The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.
        
        logStreamNamePrefix (string) --
        
        Prefix for the CloudWatch log stream name.
        
        encryptionKeyArn (string) --
        
        The Key Management Service (KMS) key ARN to encrypt the logs that you store in CloudWatch Logs.
        
        logTypes (dict) --
        
        The types of logs that you want to publish to CloudWatch. If you don't specify any log types, driver STDOUT and STDERR logs will be published to CloudWatch Logs by default. For more information including the supported worker types for Hive and Spark, see Logging for EMR Serverless with CloudWatch.
        
        Key Valid Values: SPARK_DRIVER, SPARK_EXECUTOR, HIVE_DRIVER, TEZ_TASK
        
        Array Members Valid Values: STDOUT, STDERR, HIVE_LOG, TEZ_AM, SYSTEM_LOGS
        
        (string) --
        
        Worker type for an analytics framework.
        
        (list) --
        
        (string) --
        
        Log type for a Spark/Hive job-run.
  - 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 Amazon Web Services 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.

StartJobRun (updated)

Link ¶
Changes (request)

{'configurationOverrides': {'monitoringConfiguration': {'cloudWatchLoggingConfiguration': {'enabled': 'boolean',
                                                                                           'encryptionKeyArn': 'string',
                                                                                           'logGroupName': 'string',
                                                                                           'logStreamNamePrefix': 'string',
                                                                                           'logTypes': {'string': ['string']}}}}}

Starts a job run.

See also: AWS API Documentation

Request Syntax

client.start_job_run(
    applicationId='string',
    clientToken='string',
    executionRoleArn='string',
    jobDriver={
        'sparkSubmit': {
            'entryPoint': 'string',
            'entryPointArguments': [
                'string',
            ],
            'sparkSubmitParameters': 'string'
        },
        'hive': {
            'query': 'string',
            'initQueryFile': 'string',
            'parameters': 'string'
        }
    },
    configurationOverrides={
        'applicationConfiguration': [
            {
                'classification': 'string',
                'properties': {
                    'string': 'string'
                },
                'configurations': {'... recursive ...'}
            },
        ],
        'monitoringConfiguration': {
            's3MonitoringConfiguration': {
                'logUri': 'string',
                'encryptionKeyArn': 'string'
            },
            'managedPersistenceMonitoringConfiguration': {
                'enabled': True|False,
                'encryptionKeyArn': 'string'
            },
            'cloudWatchLoggingConfiguration': {
                'enabled': True|False,
                'logGroupName': 'string',
                'logStreamNamePrefix': 'string',
                'encryptionKeyArn': 'string',
                'logTypes': {
                    'string': [
                        'string',
                    ]
                }
            }
        }
    },
    tags={
        'string': 'string'
    },
    executionTimeoutMinutes=123,
    name='string'
)

type applicationId:

string

param applicationId:

[REQUIRED]

The ID of the application on which to run the job.

type clientToken:

string

param clientToken:

[REQUIRED]

The client idempotency token of the job run to start. Its value must be unique for each request.

This field is autopopulated if not provided.

type executionRoleArn:

string

param executionRoleArn:

[REQUIRED]

The execution role ARN for the job run.

type jobDriver:

dict

param jobDriver:

The job driver for the job run.

sparkSubmit (dict) --

The job driver parameters specified for Spark.
- entryPoint (string) -- [REQUIRED]
  
  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) -- [REQUIRED]
  
  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.

type configurationOverrides:

dict

param configurationOverrides:

The configuration overrides for the job run.

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) -- [REQUIRED]
    
    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.
- cloudWatchLoggingConfiguration (dict) --
  
  The Amazon CloudWatch configuration for monitoring logs. You can configure your jobs to send log information to CloudWatch.
  - enabled (boolean) -- [REQUIRED]
    
    Enables CloudWatch logging.
  - logGroupName (string) --
    
    The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.
  - logStreamNamePrefix (string) --
    
    Prefix for the CloudWatch log stream name.
  - encryptionKeyArn (string) --
    
    The Key Management Service (KMS) key ARN to encrypt the logs that you store in CloudWatch Logs.
  - logTypes (dict) --
    
    The types of logs that you want to publish to CloudWatch. If you don't specify any log types, driver STDOUT and STDERR logs will be published to CloudWatch Logs by default. For more information including the supported worker types for Hive and Spark, see Logging for EMR Serverless with CloudWatch.
    - Key Valid Values: SPARK_DRIVER, SPARK_EXECUTOR, HIVE_DRIVER, TEZ_TASK
    - Array Members Valid Values: STDOUT, STDERR, HIVE_LOG, TEZ_AM, SYSTEM_LOGS
    - (string) --
      
      Worker type for an analytics framework.
      - (list) --
        
        (string) --
        
        Log type for a Spark/Hive job-run.

type tags:

dict

param tags:

The tags assigned to the job run.

(string) --
- (string) --

type executionTimeoutMinutes:

integer

param executionTimeoutMinutes:

The maximum duration for the job run to run. If the job run runs beyond this duration, it will be automatically cancelled.

type name:

string

param name:

The optional job run name. This doesn't have to be unique.

rtype:

dict

returns:

Response Syntax

{
    'applicationId': 'string',
    'jobRunId': 'string',
    'arn': 'string'
}

Response Structure

(dict) --
- applicationId (string) --
  
  This output displays the application ID on which the job run was submitted.
- jobRunId (string) --
  
  The output contains the ID of the started job run.
- arn (string) --
  
  This output displays the ARN of the job run..