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 StartJobRun API operation.

Syntax

Start-EMRServerlessJobRun
-ApplicationId <String>
-ConfigurationOverrides_ApplicationConfiguration <Configuration[]>
-CloudWatchLoggingConfiguration_Enabled <Boolean>
-ManagedPersistenceMonitoringConfiguration_Enabled <Boolean>
-CloudWatchLoggingConfiguration_EncryptionKeyArn <String>
-ManagedPersistenceMonitoringConfiguration_EncryptionKeyArn <String>
-S3MonitoringConfiguration_EncryptionKeyArn <String>
-SparkSubmit_EntryPoint <String>
-SparkSubmit_EntryPointArgument <String[]>
-ExecutionRoleArn <String>
-ExecutionTimeoutMinute <Int64>
-Hive_InitQueryFile <String>
-CloudWatchLoggingConfiguration_LogGroupName <String>
-CloudWatchLoggingConfiguration_LogStreamNamePrefix <String>
-CloudWatchLoggingConfiguration_LogType <Hashtable>
-S3MonitoringConfiguration_LogUri <String>
-RetryPolicy_MaxAttempt <Int32>
-RetryPolicy_MaxFailedAttemptsPerHour <Int32>
-Mode <JobRunMode>
-Name <String>
-Hive_Parameter <String>
-ExecutionIamPolicy_Policy <String>
-ExecutionIamPolicy_PolicyArn <String[]>
-Hive_Query <String>
-PrometheusMonitoringConfiguration_RemoteWriteUrl <String>
-SparkSubmit_SparkSubmitParameter <String>
-Tag <Hashtable>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonEMRServerlessConfig>

Description

Starts a job run.

Parameters

-ApplicationId <String>
The ID of the application on which to run the job.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-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 job run to start. 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)
AliasesConfigurationOverrides_MonitoringConfiguration_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)
AliasesConfigurationOverrides_MonitoringConfiguration_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)
AliasesConfigurationOverrides_MonitoringConfiguration_CloudWatchLoggingConfiguration_LogGroupName
-CloudWatchLoggingConfiguration_LogStreamNamePrefix <String>
Prefix for the CloudWatch log stream name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfigurationOverrides_MonitoringConfiguration_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
Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfigurationOverrides_MonitoringConfiguration_CloudWatchLoggingConfiguration_LogTypes
-ConfigurationOverrides_ApplicationConfiguration <Configuration[]>
The override configurations for the application. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExecutionIamPolicy_Policy <String>
An IAM inline policy to use as an execution IAM policy.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExecutionIamPolicy_PolicyArn <String[]>
A list of Amazon Resource Names (ARNs) to use as an execution IAM policy. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExecutionIamPolicy_PolicyArns
-ExecutionRoleArn <String>
The execution role ARN for the job run.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExecutionTimeoutMinute <Int64>
The maximum duration for the job run to run. If the job run runs beyond this duration, it will be automatically cancelled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExecutionTimeoutMinutes
-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)
-Hive_InitQueryFile <String>
The query file for the Hive job run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobDriver_Hive_InitQueryFile
-Hive_Parameter <String>
The parameters for the Hive job run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobDriver_Hive_Parameters
-Hive_Query <String>
The query for the Hive job run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobDriver_Hive_Query
-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)
AliasesConfigurationOverrides_MonitoringConfiguration_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)
AliasesConfigurationOverrides_MonitoringConfiguration_ManagedPersistenceMonitoringConfiguration_EncryptionKeyArn
-Mode <JobRunMode>
The mode of the job run when it starts.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The optional job run name. This doesn't have to be unique.
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)
AliasesConfigurationOverrides_MonitoringConfiguration_PrometheusMonitoringConfiguration_RemoteWriteUrl
-RetryPolicy_MaxAttempt <Int32>
Maximum number of attempts for the job run. This parameter is only applicable for BATCH mode.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRetryPolicy_MaxAttempts
-RetryPolicy_MaxFailedAttemptsPerHour <Int32>
Maximum number of failed attempts per hour. This [arameter is only applicable for STREAMING mode.
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)
AliasesConfigurationOverrides_MonitoringConfiguration_S3MonitoringConfiguration_EncryptionKeyArn
-S3MonitoringConfiguration_LogUri <String>
The Amazon S3 destination URI for log publishing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfigurationOverrides_MonitoringConfiguration_S3MonitoringConfiguration_LogUri
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EMRServerless.Model.StartJobRunResponse). Specifying the name of a property of type Amazon.EMRServerless.Model.StartJobRunResponse 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)
-SparkSubmit_EntryPoint <String>
The entry point for the Spark submit job run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobDriver_SparkSubmit_EntryPoint
-SparkSubmit_EntryPointArgument <String[]>
The arguments for the Spark submit job run. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobDriver_SparkSubmit_EntryPointArguments
-SparkSubmit_SparkSubmitParameter <String>
The parameters for the Spark submit job run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobDriver_SparkSubmit_SparkSubmitParameters
-Tag <Hashtable>
The tags assigned to the job run. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

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.StartJobRunResponse
This cmdlet returns an Amazon.EMRServerless.Model.StartJobRunResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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