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 Amazon Elastic MapReduce StartSession API operation.

Syntax

Start-EMRSession
-ClusterId <String>
-ClientRequestToken <String>
-MonitoringConfiguration_CloudWatchLoggingConfiguration_Enabled <Boolean>
-MonitoringConfiguration_ManagedLoggingConfiguration_Enabled <Boolean>
-MonitoringConfiguration_S3LoggingConfiguration_Enabled <Boolean>
-MonitoringConfiguration_CloudWatchLoggingConfiguration_EncryptionKeyArn <String>
-MonitoringConfiguration_ManagedLoggingConfiguration_EncryptionKeyArn <String>
-MonitoringConfiguration_S3LoggingConfiguration_EncryptionKeyArn <String>
-EngineConfiguration <Configuration[]>
-ExecutionRoleArn <String>
-MonitoringConfiguration_CloudWatchLoggingConfiguration_LogGroup <String>
-MonitoringConfiguration_CloudWatchLoggingConfiguration_LogStreamNamePrefix <String>
-MonitoringConfiguration_CloudWatchLoggingConfiguration_LogType <Hashtable>
-MonitoringConfiguration_S3LoggingConfiguration_LogType <Hashtable>
-MonitoringConfiguration_S3LoggingConfiguration_LogUri <String>
-Name <String>
-SessionIdleTimeoutInMinute <Int64>
-Tag <Tag[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonElasticMapReduceConfig>

Description

Creates and starts a new Spark Connect session on the specified cluster. The cluster must be in the RUNNING or WAITING state and have sessions enabled. This operation is supported in Amazon EMR Spark 8.0.0 and later.

Parameters

-ClientConfig <AmazonElasticMapReduceConfig>
Amazon.PowerShell.Cmdlets.EMR.AmazonElasticMapReduceClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientRequestToken <String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client request token, the service returns the original response without performing the operation again.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterId <String>
The ID of the cluster on which to start the session.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-EngineConfiguration <Configuration[]>
The configuration overrides for the session. Only runtime configuration overrides are supported. 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)
AliasesEngineConfigurations
-ExecutionRoleArn <String>
The execution role ARN for the session. Amazon EMR uses this role to access Amazon Web Services resources on your behalf during session execution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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)
-MonitoringConfiguration_CloudWatchLoggingConfiguration_Enabled <Boolean>
Whether CloudWatch Logs is enabled for the session.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MonitoringConfiguration_CloudWatchLoggingConfiguration_EncryptionKeyArn <String>
The Amazon Resource Name (ARN) of the KMS key used to encrypt the logs published to CloudWatch Logs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MonitoringConfiguration_CloudWatchLoggingConfiguration_LogGroup <String>
The name of the log group where session logs are published.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MonitoringConfiguration_CloudWatchLoggingConfiguration_LogStreamNamePrefix <String>
The prefix applied to the log stream name where session logs are published.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MonitoringConfiguration_CloudWatchLoggingConfiguration_LogType <Hashtable>
A map of log component names (for example, SPARK_DRIVER, SPARK_EXECUTOR) to the list of log types to publish for that component (for example, stdout, stderr). 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)
AliasesMonitoringConfiguration_CloudWatchLoggingConfiguration_LogTypes
-MonitoringConfiguration_ManagedLoggingConfiguration_Enabled <Boolean>
Whether Amazon EMR-managed logging is enabled for the session.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MonitoringConfiguration_ManagedLoggingConfiguration_EncryptionKeyArn <String>
The Amazon Resource Name (ARN) of the KMS key used to encrypt the managed logs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MonitoringConfiguration_S3LoggingConfiguration_Enabled <Boolean>
Whether Amazon S3 logging is enabled for the session.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MonitoringConfiguration_S3LoggingConfiguration_EncryptionKeyArn <String>
The Amazon Resource Name (ARN) of the KMS key used to encrypt logs published to Amazon S3.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MonitoringConfiguration_S3LoggingConfiguration_LogType <Hashtable>
A map of log component names (for example, SPARK_DRIVER, SPARK_EXECUTOR) to the list of log types to publish for that component (for example, stdout, stderr). 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)
AliasesMonitoringConfiguration_S3LoggingConfiguration_LogTypes
-MonitoringConfiguration_S3LoggingConfiguration_LogUri <String>
The Amazon S3 destination URI where session logs are published.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
An optional name for the session.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.ElasticMapReduce.Model.StartSessionResponse). Specifying the name of a property of type Amazon.ElasticMapReduce.Model.StartSessionResponse 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)
-SessionIdleTimeoutInMinute <Int64>
The idle timeout, in minutes. If the session is idle for this duration, Amazon EMR EC2 automatically terminates it.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionIdleTimeoutInMinutes
-Tag <Tag[]>
The tags to assign to the session. 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.ElasticMapReduce.Model.StartSessionResponse
This cmdlet returns an Amazon.ElasticMapReduce.Model.StartSessionResponse object containing multiple properties.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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