EMRServerless / Client / update_application

update_application#

EMRServerless.Client.update_application(**kwargs)#

Updates a specified application. An application has to be in a stopped or created state in order to be updated.

Request Syntax

response = 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'
            }
        }
    },
    interactiveConfiguration={
        'studioEnabled': True|False,
        'livyEndpointEnabled': True|False
    },
    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'
        }
    }
)

Parameters:

applicationId (string) –
[REQUIRED]

The ID of the application to update.
clientToken (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.
initialCapacity (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.
maximumCapacity (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.
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.
- 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 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.
workerTypeSpecifications (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.
interactiveConfiguration (dict) –
The interactive configuration object that contains new interactive use cases when the application is updated.
- studioEnabled (boolean) –
  
  Enables you to connect an application to Amazon EMR Studio to run interactive workloads in a notebook.
- livyEndpointEnabled (boolean) –
  
  Enables an Apache Livy endpoint that you can connect to and run interactive jobs.
releaseLabel (string) – The Amazon EMR release label for the application. You can change the release label to use a different release of Amazon EMR.
runtimeConfiguration (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.
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) – [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.

Return type:

dict

Returns:

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'
            }
        },
        'interactiveConfiguration': {
            'studioEnabled': True|False,
            'livyEndpointEnabled': True|False
        }
    }
}

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.
  - interactiveConfiguration (dict) –
    
    The interactive configuration object that enables the interactive use cases for an application.
    - studioEnabled (boolean) –
      
      Enables you to connect an application to Amazon EMR Studio to run interactive workloads in a notebook.
    - livyEndpointEnabled (boolean) –
      
      Enables an Apache Livy endpoint that you can connect to and run interactive jobs.

Exceptions

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