2024/04/18 - EMR Serverless - 5 updated api methods
Changes This release adds the capability to publish detailed Spark engine metrics to Amazon Managed Service for Prometheus (AMP) for enhanced monitoring for Spark jobs.
{'monitoringConfiguration': {'prometheusMonitoringConfiguration': {'remoteWriteUrl': 'string'}}}
Creates an application.
See also: AWS API Documentation
Request Syntax
client.create_application(
name='string',
releaseLabel='string',
type='string',
clientToken='string',
initialCapacity={
'string': {
'workerCount': 123,
'workerConfiguration': {
'cpu': 'string',
'memory': 'string',
'disk': 'string',
'diskType': 'string'
}
}
},
maximumCapacity={
'cpu': 'string',
'memory': 'string',
'disk': 'string'
},
tags={
'string': 'string'
},
autoStartConfiguration={
'enabled': True|False
},
autoStopConfiguration={
'enabled': True|False,
'idleTimeoutMinutes': 123
},
networkConfiguration={
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
]
},
architecture='ARM64'|'X86_64',
imageConfiguration={
'imageUri': 'string'
},
workerTypeSpecifications={
'string': {
'imageConfiguration': {
'imageUri': 'string'
}
}
},
runtimeConfiguration=[
{
'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',
]
}
},
'prometheusMonitoringConfiguration': {
'remoteWriteUrl': 'string'
}
}
)
string
The name of the application.
string
[REQUIRED]
The Amazon EMR release associated with the application.
string
[REQUIRED]
The type of application you want to start, such as Spark or Hive.
string
[REQUIRED]
The client idempotency token of the application to create. Its value must be unique for each request.
This field is autopopulated if not provided.
dict
The capacity to initialize when the application is created.
(string) --
Worker type for an analytics framework.
(dict) --
The initial capacity configuration per worker.
workerCount (integer) -- [REQUIRED]
The number of workers in the initial capacity configuration.
workerConfiguration (dict) --
The resource configuration of the initial capacity configuration.
cpu (string) -- [REQUIRED]
The CPU requirements for every worker instance of the worker type.
memory (string) -- [REQUIRED]
The memory requirements for every worker instance of the worker type.
disk (string) --
The disk requirements for every worker instance of the worker type.
diskType (string) --
The disk type for every worker instance of the work type. Shuffle optimized disks have higher performance characteristics and are better for shuffle heavy workloads. Default is STANDARD .
dict
The maximum capacity to allocate when the application is created. This is cumulative across all workers at any given point in time, not just when an application is created. No new resources will be created once any one of the defined limits is hit.
cpu (string) -- [REQUIRED]
The maximum allowed CPU for an application.
memory (string) -- [REQUIRED]
The maximum allowed resources for an application.
disk (string) --
The maximum allowed disk for an application.
dict
The tags assigned to the application.
(string) --
(string) --
dict
The configuration for an application to automatically start on job submission.
enabled (boolean) --
Enables the application to automatically start on job submission. Defaults to true.
dict
The configuration for an application to automatically stop after a certain amount of time being idle.
enabled (boolean) --
Enables the application to automatically stop after a certain amount of time being idle. Defaults to true.
idleTimeoutMinutes (integer) --
The amount of idle time in minutes after which your application will automatically stop. Defaults to 15 minutes.
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) --
string
The CPU architecture of an application.
dict
The image configuration for all worker types. You can either set this parameter or imageConfiguration for each worker type in workerTypeSpecifications .
imageUri (string) --
The URI of an image in the Amazon ECR registry. This field is required when you create a new application. If you leave this field blank in an update, Amazon EMR will remove the image configuration.
dict
The key-value pairs that specify worker type to WorkerTypeSpecificationInput . This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types.
(string) --
Worker type for an analytics framework.
(dict) --
The specifications for a worker type.
imageConfiguration (dict) --
The image configuration for a worker type.
imageUri (string) --
The URI of an image in the Amazon ECR registry. This field is required when you create a new application. If you leave this field blank in an update, Amazon EMR will remove the image configuration.
list
The Configuration specifications to use when creating an application. Each configuration consists of a classification and properties. This configuration is applied to all the job runs submitted under 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.
dict
The configuration setting 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.
prometheusMonitoringConfiguration (dict) --
The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.
remoteWriteUrl (string) --
The remote write URL in the Amazon Managed Service for Prometheus workspace to send metrics to.
dict
Response Syntax
{
'applicationId': 'string',
'name': 'string',
'arn': 'string'
}
Response Structure
(dict) --
applicationId (string) --
The output contains the application ID.
name (string) --
The output contains the name of the application.
arn (string) --
The output contains the ARN of the application.
{'application': {'monitoringConfiguration': {'prometheusMonitoringConfiguration': {'remoteWriteUrl': 'string'}}}}
Displays detailed information about a specified application.
See also: AWS API Documentation
Request Syntax
client.get_application(
applicationId='string'
)
string
[REQUIRED]
The ID of the application that will be described.
dict
Response Syntax
{
'application': {
'applicationId': 'string',
'name': 'string',
'arn': 'string',
'releaseLabel': 'string',
'type': 'string',
'state': 'CREATING'|'CREATED'|'STARTING'|'STARTED'|'STOPPING'|'STOPPED'|'TERMINATED',
'stateDetails': 'string',
'initialCapacity': {
'string': {
'workerCount': 123,
'workerConfiguration': {
'cpu': 'string',
'memory': 'string',
'disk': 'string',
'diskType': 'string'
}
}
},
'maximumCapacity': {
'cpu': 'string',
'memory': 'string',
'disk': 'string'
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'tags': {
'string': 'string'
},
'autoStartConfiguration': {
'enabled': True|False
},
'autoStopConfiguration': {
'enabled': True|False,
'idleTimeoutMinutes': 123
},
'networkConfiguration': {
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
]
},
'architecture': 'ARM64'|'X86_64',
'imageConfiguration': {
'imageUri': 'string',
'resolvedImageDigest': 'string'
},
'workerTypeSpecifications': {
'string': {
'imageConfiguration': {
'imageUri': 'string',
'resolvedImageDigest': 'string'
}
}
},
'runtimeConfiguration': [
{
'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',
]
}
},
'prometheusMonitoringConfiguration': {
'remoteWriteUrl': 'string'
}
}
}
}
Response Structure
(dict) --
application (dict) --
The output displays information about the specified application.
applicationId (string) --
The ID of the application.
name (string) --
The name of the application.
arn (string) --
The ARN of the application.
releaseLabel (string) --
The Amazon EMR release associated with the application.
type (string) --
The type of application, such as Spark or Hive.
state (string) --
The state of the application.
stateDetails (string) --
The state details of the application.
initialCapacity (dict) --
The initial capacity of the application.
(string) --
Worker type for an analytics framework.
(dict) --
The initial capacity configuration per worker.
workerCount (integer) --
The number of workers in the initial capacity configuration.
workerConfiguration (dict) --
The resource configuration of the initial capacity configuration.
cpu (string) --
The CPU requirements for every worker instance of the worker type.
memory (string) --
The memory requirements for every worker instance of the worker type.
disk (string) --
The disk requirements for every worker instance of the worker type.
diskType (string) --
The disk type for every worker instance of the work type. Shuffle optimized disks have higher performance characteristics and are better for shuffle heavy workloads. Default is STANDARD .
maximumCapacity (dict) --
The maximum capacity of the application. This is cumulative across all workers at any given point in time during the lifespan of the application is created. No new resources will be created once any one of the defined limits is hit.
cpu (string) --
The maximum allowed CPU for an application.
memory (string) --
The maximum allowed resources for an application.
disk (string) --
The maximum allowed disk for an application.
createdAt (datetime) --
The date and time when the application run was created.
updatedAt (datetime) --
The date and time when the application run was last updated.
tags (dict) --
The tags assigned to the application.
(string) --
(string) --
autoStartConfiguration (dict) --
The configuration for an application to automatically start on job submission.
enabled (boolean) --
Enables the application to automatically start on job submission. Defaults to true.
autoStopConfiguration (dict) --
The configuration for an application to automatically stop after a certain amount of time being idle.
enabled (boolean) --
Enables the application to automatically stop after a certain amount of time being idle. Defaults to true.
idleTimeoutMinutes (integer) --
The amount of idle time in minutes after which your application will automatically stop. Defaults to 15 minutes.
networkConfiguration (dict) --
The network configuration for customer VPC connectivity for the application.
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) --
architecture (string) --
The CPU architecture of an application.
imageConfiguration (dict) --
The image configuration applied to all worker types.
imageUri (string) --
The image URI.
resolvedImageDigest (string) --
The SHA256 digest of the image URI. This indicates which specific image the application is configured for. The image digest doesn't exist until an application has started.
workerTypeSpecifications (dict) --
The specification applied to each worker type.
(string) --
Worker type for an analytics framework.
(dict) --
The specifications for a worker type.
imageConfiguration (dict) --
The image configuration for a worker type.
imageUri (string) --
The image URI.
resolvedImageDigest (string) --
The SHA256 digest of the image URI. This indicates which specific image the application is configured for. The image digest doesn't exist until an application has started.
runtimeConfiguration (list) --
The Configuration specifications of an application. Each configuration consists of a classification and properties. You use this parameter when creating or updating an application. To see the runtimeConfiguration object of an application, run the GetApplication API operation.
(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 configuration setting 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.
prometheusMonitoringConfiguration (dict) --
The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.
remoteWriteUrl (string) --
The remote write URL in the Amazon Managed Service for Prometheus workspace to send metrics to.
{'jobRun': {'configurationOverrides': {'monitoringConfiguration': {'prometheusMonitoringConfiguration': {'remoteWriteUrl': 'string'}}}}}
Displays detailed information about a job run.
See also: AWS API Documentation
Request Syntax
client.get_job_run(
applicationId='string',
jobRunId='string'
)
string
[REQUIRED]
The ID of the application on which the job run is submitted.
string
[REQUIRED]
The ID of the job run.
dict
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',
]
}
},
'prometheusMonitoringConfiguration': {
'remoteWriteUrl': '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.
prometheusMonitoringConfiguration (dict) --
The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.
remoteWriteUrl (string) --
The remote write URL in the Amazon Managed Service for Prometheus workspace to send metrics to.
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.
{'configurationOverrides': {'monitoringConfiguration': {'prometheusMonitoringConfiguration': {'remoteWriteUrl': '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',
]
}
},
'prometheusMonitoringConfiguration': {
'remoteWriteUrl': 'string'
}
}
},
tags={
'string': 'string'
},
executionTimeoutMinutes=123,
name='string'
)
string
[REQUIRED]
The ID of the application on which to run the job.
string
[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.
string
[REQUIRED]
The execution role ARN for the job run.
dict
The job driver for the job run.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: sparkSubmit, hive.
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.
dict
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.
prometheusMonitoringConfiguration (dict) --
The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.
remoteWriteUrl (string) --
The remote write URL in the Amazon Managed Service for Prometheus workspace to send metrics to.
dict
The tags assigned to the job run.
(string) --
(string) --
integer
The maximum duration for the job run to run. If the job run runs beyond this duration, it will be automatically cancelled.
string
The optional job run name. This doesn't have to be unique.
dict
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..
{'monitoringConfiguration': {'prometheusMonitoringConfiguration': {'remoteWriteUrl': 'string'}}}
Response {'application': {'monitoringConfiguration': {'prometheusMonitoringConfiguration': {'remoteWriteUrl': 'string'}}}}
Updates a specified application. An application has to be in a stopped or created state in order to be updated.
See also: AWS API Documentation
Request Syntax
client.update_application(
applicationId='string',
clientToken='string',
initialCapacity={
'string': {
'workerCount': 123,
'workerConfiguration': {
'cpu': 'string',
'memory': 'string',
'disk': 'string',
'diskType': 'string'
}
}
},
maximumCapacity={
'cpu': 'string',
'memory': 'string',
'disk': 'string'
},
autoStartConfiguration={
'enabled': True|False
},
autoStopConfiguration={
'enabled': True|False,
'idleTimeoutMinutes': 123
},
networkConfiguration={
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
]
},
architecture='ARM64'|'X86_64',
imageConfiguration={
'imageUri': 'string'
},
workerTypeSpecifications={
'string': {
'imageConfiguration': {
'imageUri': 'string'
}
}
},
releaseLabel='string',
runtimeConfiguration=[
{
'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',
]
}
},
'prometheusMonitoringConfiguration': {
'remoteWriteUrl': 'string'
}
}
)
string
[REQUIRED]
The ID of the application to update.
string
[REQUIRED]
The client idempotency token of the application to update. Its value must be unique for each request.
This field is autopopulated if not provided.
dict
The capacity to initialize when the application is updated.
(string) --
Worker type for an analytics framework.
(dict) --
The initial capacity configuration per worker.
workerCount (integer) -- [REQUIRED]
The number of workers in the initial capacity configuration.
workerConfiguration (dict) --
The resource configuration of the initial capacity configuration.
cpu (string) -- [REQUIRED]
The CPU requirements for every worker instance of the worker type.
memory (string) -- [REQUIRED]
The memory requirements for every worker instance of the worker type.
disk (string) --
The disk requirements for every worker instance of the worker type.
diskType (string) --
The disk type for every worker instance of the work type. Shuffle optimized disks have higher performance characteristics and are better for shuffle heavy workloads. Default is STANDARD .
dict
The maximum capacity to allocate when the application is updated. This is cumulative across all workers at any given point in time during the lifespan of the application. No new resources will be created once any one of the defined limits is hit.
cpu (string) -- [REQUIRED]
The maximum allowed CPU for an application.
memory (string) -- [REQUIRED]
The maximum allowed resources for an application.
disk (string) --
The maximum allowed disk for an application.
dict
The configuration for an application to automatically start on job submission.
enabled (boolean) --
Enables the application to automatically start on job submission. Defaults to true.
dict
The configuration for an application to automatically stop after a certain amount of time being idle.
enabled (boolean) --
Enables the application to automatically stop after a certain amount of time being idle. Defaults to true.
idleTimeoutMinutes (integer) --
The amount of idle time in minutes after which your application will automatically stop. Defaults to 15 minutes.
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) --
string
The CPU architecture of an application.
dict
The image configuration to be used for all worker types. You can either set this parameter or imageConfiguration for each worker type in WorkerTypeSpecificationInput .
imageUri (string) --
The URI of an image in the Amazon ECR registry. This field is required when you create a new application. If you leave this field blank in an update, Amazon EMR will remove the image configuration.
dict
The key-value pairs that specify worker type to WorkerTypeSpecificationInput . This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types.
(string) --
Worker type for an analytics framework.
(dict) --
The specifications for a worker type.
imageConfiguration (dict) --
The image configuration for a worker type.
imageUri (string) --
The URI of an image in the Amazon ECR registry. This field is required when you create a new application. If you leave this field blank in an update, Amazon EMR will remove the image configuration.
string
The Amazon EMR release label for the application. You can change the release label to use a different release of Amazon EMR.
list
The Configuration specifications to use when updating an application. Each configuration consists of a classification and properties. This configuration is applied across all the job runs submitted under 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.
dict
The configuration setting 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.
prometheusMonitoringConfiguration (dict) --
The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.
remoteWriteUrl (string) --
The remote write URL in the Amazon Managed Service for Prometheus workspace to send metrics to.
dict
Response Syntax
{
'application': {
'applicationId': 'string',
'name': 'string',
'arn': 'string',
'releaseLabel': 'string',
'type': 'string',
'state': 'CREATING'|'CREATED'|'STARTING'|'STARTED'|'STOPPING'|'STOPPED'|'TERMINATED',
'stateDetails': 'string',
'initialCapacity': {
'string': {
'workerCount': 123,
'workerConfiguration': {
'cpu': 'string',
'memory': 'string',
'disk': 'string',
'diskType': 'string'
}
}
},
'maximumCapacity': {
'cpu': 'string',
'memory': 'string',
'disk': 'string'
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'tags': {
'string': 'string'
},
'autoStartConfiguration': {
'enabled': True|False
},
'autoStopConfiguration': {
'enabled': True|False,
'idleTimeoutMinutes': 123
},
'networkConfiguration': {
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
]
},
'architecture': 'ARM64'|'X86_64',
'imageConfiguration': {
'imageUri': 'string',
'resolvedImageDigest': 'string'
},
'workerTypeSpecifications': {
'string': {
'imageConfiguration': {
'imageUri': 'string',
'resolvedImageDigest': 'string'
}
}
},
'runtimeConfiguration': [
{
'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',
]
}
},
'prometheusMonitoringConfiguration': {
'remoteWriteUrl': 'string'
}
}
}
}
Response Structure
(dict) --
application (dict) --
Information about the updated application.
applicationId (string) --
The ID of the application.
name (string) --
The name of the application.
arn (string) --
The ARN of the application.
releaseLabel (string) --
The Amazon EMR release associated with the application.
type (string) --
The type of application, such as Spark or Hive.
state (string) --
The state of the application.
stateDetails (string) --
The state details of the application.
initialCapacity (dict) --
The initial capacity of the application.
(string) --
Worker type for an analytics framework.
(dict) --
The initial capacity configuration per worker.
workerCount (integer) --
The number of workers in the initial capacity configuration.
workerConfiguration (dict) --
The resource configuration of the initial capacity configuration.
cpu (string) --
The CPU requirements for every worker instance of the worker type.
memory (string) --
The memory requirements for every worker instance of the worker type.
disk (string) --
The disk requirements for every worker instance of the worker type.
diskType (string) --
The disk type for every worker instance of the work type. Shuffle optimized disks have higher performance characteristics and are better for shuffle heavy workloads. Default is STANDARD .
maximumCapacity (dict) --
The maximum capacity of the application. This is cumulative across all workers at any given point in time during the lifespan of the application is created. No new resources will be created once any one of the defined limits is hit.
cpu (string) --
The maximum allowed CPU for an application.
memory (string) --
The maximum allowed resources for an application.
disk (string) --
The maximum allowed disk for an application.
createdAt (datetime) --
The date and time when the application run was created.
updatedAt (datetime) --
The date and time when the application run was last updated.
tags (dict) --
The tags assigned to the application.
(string) --
(string) --
autoStartConfiguration (dict) --
The configuration for an application to automatically start on job submission.
enabled (boolean) --
Enables the application to automatically start on job submission. Defaults to true.
autoStopConfiguration (dict) --
The configuration for an application to automatically stop after a certain amount of time being idle.
enabled (boolean) --
Enables the application to automatically stop after a certain amount of time being idle. Defaults to true.
idleTimeoutMinutes (integer) --
The amount of idle time in minutes after which your application will automatically stop. Defaults to 15 minutes.
networkConfiguration (dict) --
The network configuration for customer VPC connectivity for the application.
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) --
architecture (string) --
The CPU architecture of an application.
imageConfiguration (dict) --
The image configuration applied to all worker types.
imageUri (string) --
The image URI.
resolvedImageDigest (string) --
The SHA256 digest of the image URI. This indicates which specific image the application is configured for. The image digest doesn't exist until an application has started.
workerTypeSpecifications (dict) --
The specification applied to each worker type.
(string) --
Worker type for an analytics framework.
(dict) --
The specifications for a worker type.
imageConfiguration (dict) --
The image configuration for a worker type.
imageUri (string) --
The image URI.
resolvedImageDigest (string) --
The SHA256 digest of the image URI. This indicates which specific image the application is configured for. The image digest doesn't exist until an application has started.
runtimeConfiguration (list) --
The Configuration specifications of an application. Each configuration consists of a classification and properties. You use this parameter when creating or updating an application. To see the runtimeConfiguration object of an application, run the GetApplication API operation.
(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 configuration setting 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.
prometheusMonitoringConfiguration (dict) --
The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.
remoteWriteUrl (string) --
The remote write URL in the Amazon Managed Service for Prometheus workspace to send metrics to.