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

Syntax

Start-EMRNotebookExecution
-NotebookS3Location_Bucket <String>
-OutputNotebookS3Location_Bucket <String>
-EditorId <String>
-EnvironmentVariable <Hashtable>
-ExecutionEngine_ExecutionRoleArn <String>
-ExecutionEngine_Id <String>
-NotebookS3Location_Key <String>
-OutputNotebookS3Location_Key <String>
-ExecutionEngine_MasterInstanceSecurityGroupId <String>
-NotebookExecutionName <String>
-NotebookInstanceSecurityGroupId <String>
-NotebookParam <String>
-OutputNotebookFormat <OutputNotebookFormat>
-RelativePath <String>
-ServiceRole <String>
-Tag <Tag[]>
-ExecutionEngine_Type <ExecutionEngineType>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonElasticMapReduceConfig>

Description

Starts a notebook execution.

Parameters

-ClientConfig <AmazonElasticMapReduceConfig>
Amazon.PowerShell.Cmdlets.EMR.AmazonElasticMapReduceClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EditorId <String>
The unique identifier of the Amazon EMR Notebook to use for notebook execution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnvironmentVariable <Hashtable>
The environment variables associated with the notebook execution. 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)
AliasesEnvironmentVariables
-ExecutionEngine_ExecutionRoleArn <String>
The execution role ARN required for the notebook execution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExecutionEngine_Id <String>
The unique identifier of the execution engine. For an Amazon EMR cluster, this is the cluster ID.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExecutionEngine_MasterInstanceSecurityGroupId <String>
An optional unique ID of an Amazon EC2 security group to associate with the master instance of the Amazon EMR cluster for this notebook execution. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the EMR Management Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExecutionEngine_Type <ExecutionEngineType>
The type of execution engine. A value of EMR specifies an Amazon EMR cluster.
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)
-NotebookExecutionName <String>
An optional name for the notebook execution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NotebookInstanceSecurityGroupId <String>
The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NotebookParam <String>
Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNotebookParams
-NotebookS3Location_Bucket <String>
The Amazon S3 bucket that stores the notebook execution input.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NotebookS3Location_Key <String>
The key to the Amazon S3 location that stores the notebook execution input.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputNotebookFormat <OutputNotebookFormat>
The output format for the notebook execution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputNotebookS3Location_Bucket <String>
The Amazon S3 bucket that stores the notebook execution output.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputNotebookS3Location_Key <String>
The key to the Amazon S3 location that stores the notebook execution output.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RelativePath <String>
The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an Amazon EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this request), and you specify a RelativePath of my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'NotebookExecutionId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticMapReduce.Model.StartNotebookExecutionResponse). Specifying the name of a property of type Amazon.ElasticMapReduce.Model.StartNotebookExecutionResponse 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)
-ServiceRole <String>
The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters. 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

System.String or Amazon.ElasticMapReduce.Model.StartNotebookExecutionResponse
This cmdlet returns a System.String object. The service call response (type Amazon.ElasticMapReduce.Model.StartNotebookExecutionResponse) can be returned by specifying '-Select *'.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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