2023/01/05 - EMR Serverless - 3 updated api methods
Changes Adds support for customized images. You can now provide runtime images when creating or updating EMR Serverless Applications.
{'imageConfiguration': {'imageUri': 'string'},
'workerTypeSpecifications': {'string': {'imageConfiguration': {'imageUri': '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'
}
}
},
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'
}
}
}
)
string
The name of the application.
string
[REQUIRED]
The 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) --
(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.
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) --
(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.
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': {'imageConfiguration': {'imageUri': 'string',
'resolvedImageDigest': 'string'},
'workerTypeSpecifications': {'string': {'imageConfiguration': {'imageUri': 'string',
'resolvedImageDigest': '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'
}
}
},
'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'
}
}
}
}
}
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 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) --
(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.
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) --
(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.
{'imageConfiguration': {'imageUri': 'string'},
'workerTypeSpecifications': {'string': {'imageConfiguration': {'imageUri': 'string'}}}}
Response {'application': {'imageConfiguration': {'imageUri': 'string',
'resolvedImageDigest': 'string'},
'workerTypeSpecifications': {'string': {'imageConfiguration': {'imageUri': 'string',
'resolvedImageDigest': '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'
}
}
},
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'
}
}
}
)
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) --
(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.
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) --
(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.
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'
}
}
},
'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'
}
}
}
}
}
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 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) --
(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.
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) --
(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.