AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the EMR Serverless UpdateApplication API operation.

Syntax

Update-EMRServerlessApplication
-ApplicationId <String>
-Architecture <Architecture>
-MaximumCapacity_Cpu <String>
-MaximumCapacity_Disk <String>
-AutoStartConfiguration_Enabled <Boolean>
-AutoStopConfiguration_Enabled <Boolean>
-CloudWatchLoggingConfiguration_Enabled <Boolean>
-ManagedPersistenceMonitoringConfiguration_Enabled <Boolean>
-CloudWatchLoggingConfiguration_EncryptionKeyArn <String>
-ManagedPersistenceMonitoringConfiguration_EncryptionKeyArn <String>
-S3MonitoringConfiguration_EncryptionKeyArn <String>
-AutoStopConfiguration_IdleTimeoutMinute <Int32>
-ImageConfiguration_ImageUri <String>
-InitialCapacity <Hashtable>
-InteractiveConfiguration_LivyEndpointEnabled <Boolean>
-CloudWatchLoggingConfiguration_LogGroupName <String>
-CloudWatchLoggingConfiguration_LogStreamNamePrefix <String>
-CloudWatchLoggingConfiguration_LogType <Hashtable>
-S3MonitoringConfiguration_LogUri <String>
-SchedulerConfiguration_MaxConcurrentRun <Int32>
-MaximumCapacity_Memory <String>
-SchedulerConfiguration_QueueTimeoutMinute <Int32>
-ReleaseLabel <String>
-PrometheusMonitoringConfiguration_RemoteWriteUrl <String>
-RuntimeConfiguration <Configuration[]>
-NetworkConfiguration_SecurityGroupId <String[]>
-InteractiveConfiguration_StudioEnabled <Boolean>
-NetworkConfiguration_SubnetId <String[]>
-WorkerTypeSpecification <Hashtable>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonEMRServerlessConfig>

Description

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

Parameters

-ApplicationId <String>
The ID of the application to update.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Architecture <Architecture>
The CPU architecture of an application.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoStartConfiguration_Enabled <Boolean>
Enables the application to automatically start on job submission. Defaults to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoStopConfiguration_Enabled <Boolean>
Enables the application to automatically stop after a certain amount of time being idle. Defaults to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoStopConfiguration_IdleTimeoutMinute <Int32>
The amount of idle time in minutes after which your application will automatically stop. Defaults to 15 minutes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoStopConfiguration_IdleTimeoutMinutes
-ClientConfig <AmazonEMRServerlessConfig>
Amazon.PowerShell.Cmdlets.EMRServerless.AmazonEMRServerlessClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
The client idempotency token of the application to update. Its value must be unique for each request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CloudWatchLoggingConfiguration_Enabled <Boolean>
Enables CloudWatch logging.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMonitoringConfiguration_CloudWatchLoggingConfiguration_Enabled
-CloudWatchLoggingConfiguration_EncryptionKeyArn <String>
The Key Management Service (KMS) key ARN to encrypt the logs that you store in CloudWatch Logs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMonitoringConfiguration_CloudWatchLoggingConfiguration_EncryptionKeyArn
-CloudWatchLoggingConfiguration_LogGroupName <String>
The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMonitoringConfiguration_CloudWatchLoggingConfiguration_LogGroupName
-CloudWatchLoggingConfiguration_LogStreamNamePrefix <String>
Prefix for the CloudWatch log stream name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMonitoringConfiguration_CloudWatchLoggingConfiguration_LogStreamNamePrefix
-CloudWatchLoggingConfiguration_LogType <Hashtable>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMonitoringConfiguration_CloudWatchLoggingConfiguration_LogTypes
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageConfiguration_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InitialCapacity <Hashtable>
The capacity to initialize when the application is updated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InteractiveConfiguration_LivyEndpointEnabled <Boolean>
Enables an Apache Livy endpoint that you can connect to and run interactive jobs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InteractiveConfiguration_StudioEnabled <Boolean>
Enables you to connect an application to Amazon EMR Studio to run interactive workloads in a notebook.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedPersistenceMonitoringConfiguration_Enabled <Boolean>
Enables managed logging and defaults to true. If set to false, managed logging will be turned off.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMonitoringConfiguration_ManagedPersistenceMonitoringConfiguration_Enabled
-ManagedPersistenceMonitoringConfiguration_EncryptionKeyArn <String>
The KMS key ARN to encrypt the logs stored in managed log persistence.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMonitoringConfiguration_ManagedPersistenceMonitoringConfiguration_EncryptionKeyArn
-MaximumCapacity_Cpu <String>
The maximum allowed CPU for an application.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaximumCapacity_Disk <String>
The maximum allowed disk for an application.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaximumCapacity_Memory <String>
The maximum allowed resources for an application.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkConfiguration_SecurityGroupId <String[]>
The array of security group Ids for customer VPC connectivity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNetworkConfiguration_SecurityGroupIds
-NetworkConfiguration_SubnetId <String[]>
The array of subnet Ids for customer VPC connectivity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNetworkConfiguration_SubnetIds
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ApplicationId parameter. The -PassThru parameter is deprecated, use -Select '^ApplicationId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PrometheusMonitoringConfiguration_RemoteWriteUrl <String>
The remote write URL in the Amazon Managed Service for Prometheus workspace to send metrics to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMonitoringConfiguration_PrometheusMonitoringConfiguration_RemoteWriteUrl
-ReleaseLabel <String>
The Amazon EMR release label for the application. You can change the release label to use a different release of Amazon EMR.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RuntimeConfiguration <Configuration[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3MonitoringConfiguration_EncryptionKeyArn <String>
The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMonitoringConfiguration_S3MonitoringConfiguration_EncryptionKeyArn
-S3MonitoringConfiguration_LogUri <String>
The Amazon S3 destination URI for log publishing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMonitoringConfiguration_S3MonitoringConfiguration_LogUri
-SchedulerConfiguration_MaxConcurrentRun <Int32>
The maximum concurrent job runs on this application. If scheduler configuration is enabled on your application, the default value is 15. The valid range is 1 to 1000.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSchedulerConfiguration_MaxConcurrentRuns
-SchedulerConfiguration_QueueTimeoutMinute <Int32>
The maximum duration in minutes for the job in QUEUED state. If scheduler configuration is enabled on your application, the default value is 360 minutes (6 hours). The valid range is from 15 to 720.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSchedulerConfiguration_QueueTimeoutMinutes
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Application'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EMRServerless.Model.UpdateApplicationResponse). Specifying the name of a property of type Amazon.EMRServerless.Model.UpdateApplicationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WorkerTypeSpecification <Hashtable>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWorkerTypeSpecifications

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.EMRServerless.Model.Application or Amazon.EMRServerless.Model.UpdateApplicationResponse
This cmdlet returns an Amazon.EMRServerless.Model.Application object. The service call response (type Amazon.EMRServerless.Model.UpdateApplicationResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z