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

Syntax

Start-EMRJobFlow
-Name <String>
-LogUri <String>
-AdditionalInfo <String>
-Instances_AdditionalMasterSecurityGroup <String[]>
-Instances_AdditionalSlaveSecurityGroup <String[]>
-KerberosAttributes_ADDomainJoinPassword <String>
-KerberosAttributes_ADDomainJoinUser <String>
-AmiVersion <String>
-Application <Application[]>
-AutoScalingRole <String>
-Instances_Placement_AvailabilityZone <String>
-Instances_Placement_AvailabilityZones <String[]>
-BootstrapAction <BootstrapActionConfig[]>
-Configuration <Configuration[]>
-KerberosAttributes_CrossRealmTrustPrincipalPassword <String>
-CustomAmiId <String>
-EbsRootVolumeIops <Int32>
-EbsRootVolumeSize <Int32>
-EbsRootVolumeThroughput <Int32>
-Instances_Ec2KeyName <String>
-Instances_Ec2SubnetId <String>
-Instances_Ec2SubnetIds <String[]>
-Instances_EmrManagedMasterSecurityGroup <String>
-Instances_EmrManagedSlaveSecurityGroup <String>
-Instances_HadoopVersion <String>
-AutoTerminationPolicy_IdleTimeout <Int64>
-Instances_InstanceCount <Int32>
-Instances_InstanceFleet <InstanceFleetConfig[]>
-Instances_InstanceGroup <InstanceGroupConfig[]>
-JobFlowRole <String>
-KerberosAttributes_KdcAdminPassword <String>
-Instances_KeepJobFlowAliveWhenNoStep <Boolean>
-LogEncryptionKmsKeyId <String>
-Instances_MasterInstanceType <String>
-ComputeLimits_MaximumCapacityUnit <Int32>
-ComputeLimits_MaximumCoreCapacityUnit <Int32>
-ComputeLimits_MaximumOnDemandCapacityUnit <Int32>
-ComputeLimits_MinimumCapacityUnit <Int32>
-NewSupportedProduct <SupportedProductConfig[]>
-OSReleaseLabel <String>
-PlacementGroupConfig <PlacementGroupConfig[]>
-KerberosAttributes_Realm <String>
-ReleaseLabel <String>
-RepoUpgradeOnBoot <RepoUpgradeOnBoot>
-ScaleDownBehavior <ScaleDownBehavior>
-SecurityConfiguration <String>
-Instances_ServiceAccessSecurityGroup <String>
-ServiceRole <String>
-Instances_SlaveInstanceType <String>
-StepConcurrencyLevel <Int32>
-Step <StepConfig[]>
-SupportedProduct <String[]>
-Tag <Tag[]>
-Instances_TerminationProtected <Boolean>
-Instances_UnhealthyNodeReplacement <Boolean>
-ComputeLimits_UnitType <ComputeLimitsUnitType>
-VisibleToAllUser <Boolean>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonElasticMapReduceConfig>

Description

RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the steps specified. After the steps complete, the cluster stops and the HDFS partition is lost. To prevent loss of data, configure the last step of the job flow to store results in Amazon S3. If the JobFlowInstancesConfigKeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the cluster transitions to the WAITING state rather than shutting down after the steps have completed. For additional protection, you can set the JobFlowInstancesConfigTerminationProtected parameter to TRUE to lock the cluster and prevent it from being terminated by API call, user intervention, or in the event of a job flow error. A maximum of 256 steps are allowed in each job flow. If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For long-running clusters, we recommend that you periodically store your results. The instance fleets configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain InstanceFleets parameters or InstanceGroups parameters, but not both.

Parameters

-AdditionalInfo <String>
A JSON string for selecting additional features.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AmiVersion <String>
Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Application <Application[]>
Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. For a list of applications available for each Amazon EMR release version, see the Amazon EMRRelease Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApplications
-AutoScalingRole <String>
An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoTerminationPolicy_IdleTimeout <Int64>
Specifies the amount of idle time in seconds after which the cluster automatically terminates. You can specify a minimum of 60 seconds and a maximum of 604800 seconds (seven days).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BootstrapAction <BootstrapActionConfig[]>
A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBootstrapActions
-ClientConfig <AmazonElasticMapReduceConfig>
Amazon.PowerShell.Cmdlets.EMR.AmazonElasticMapReduceClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeLimits_MaximumCapacityUnit <Int32>
The upper boundary of Amazon EC2 units. It is measured through vCPU cores or instances for instance groups and measured through units for instance fleets. Managed scaling activities are not allowed beyond this boundary. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedScalingPolicy_ComputeLimits_MaximumCapacityUnits
-ComputeLimits_MaximumCoreCapacityUnit <Int32>
The upper boundary of Amazon EC2 units for core node type in a cluster. It is measured through vCPU cores or instances for instance groups and measured through units for instance fleets. The core units are not allowed to scale beyond this boundary. The parameter is used to split capacity allocation between core and task nodes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedScalingPolicy_ComputeLimits_MaximumCoreCapacityUnits
-ComputeLimits_MaximumOnDemandCapacityUnit <Int32>
The upper boundary of On-Demand Amazon EC2 units. It is measured through vCPU cores or instances for instance groups and measured through units for instance fleets. The On-Demand units are not allowed to scale beyond this boundary. The parameter is used to split capacity allocation between On-Demand and Spot Instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedScalingPolicy_ComputeLimits_MaximumOnDemandCapacityUnits
-ComputeLimits_MinimumCapacityUnit <Int32>
The lower boundary of Amazon EC2 units. It is measured through vCPU cores or instances for instance groups and measured through units for instance fleets. Managed scaling activities are not allowed beyond this boundary. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedScalingPolicy_ComputeLimits_MinimumCapacityUnits
-ComputeLimits_UnitType <ComputeLimitsUnitType>
The unit type used for specifying a managed scaling policy.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedScalingPolicy_ComputeLimits_UnitType
-Configuration <Configuration[]>
For Amazon EMR releases 4.0 and later. The list of configurations supplied for the Amazon EMR cluster that you are creating.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfigurations
-CustomAmiId <String>
Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches cluster Amazon EC2 instances. For more information about custom AMIs in Amazon EMR, see Using a Custom AMI in the Amazon EMR Management Guide. If omitted, the cluster uses the base Linux AMI for the ReleaseLabel specified. For Amazon EMR releases 2.x and 3.x, use AmiVersion instead.For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For information about finding an AMI ID, see Finding a Linux AMI.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EbsRootVolumeIops <Int32>
The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EbsRootVolumeSize <Int32>
The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and later.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EbsRootVolumeThroughput <Int32>
The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.
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)
-Instances_AdditionalMasterSecurityGroup <String[]>
A list of additional Amazon EC2 security group IDs for the master node.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstances_AdditionalMasterSecurityGroups
-Instances_AdditionalSlaveSecurityGroup <String[]>
A list of additional Amazon EC2 security group IDs for the core and task nodes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstances_AdditionalSlaveSecurityGroups
-Instances_Ec2KeyName <String>
The name of the Amazon EC2 key pair that can be used to connect to the master node using SSH as the user called "hadoop."
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Instances_Ec2SubnetId <String>
Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value and your account supports EC2-Classic, the cluster launches in EC2-Classic.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Instances_Ec2SubnetIds <String[]>
Applies to clusters that use the instance fleet configuration. When multiple Amazon EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances in the optimal subnet.The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Instances_EmrManagedMasterSecurityGroup <String>
The identifier of the Amazon EC2 security group for the master node. If you specify EmrManagedMasterSecurityGroup, you must also specify EmrManagedSlaveSecurityGroup.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Instances_EmrManagedSlaveSecurityGroup <String>
The identifier of the Amazon EC2 security group for the core and task nodes. If you specify EmrManagedSlaveSecurityGroup, you must also specify EmrManagedMasterSecurityGroup.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Instances_HadoopVersion <String>
Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version for the cluster. Valid inputs are "0.18" (no longer maintained), "0.20" (no longer maintained), "0.20.205" (no longer maintained), "1.0.3", "2.2.0", or "2.4.0". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Instances_InstanceCount <Int32>
The number of Amazon EC2 instances in the cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Instances_InstanceFleet <InstanceFleetConfig[]>
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.Describes the Amazon EC2 instances and instance configurations for clusters that use the instance fleet configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstances_InstanceFleets
-Instances_InstanceGroup <InstanceGroupConfig[]>
Configuration for the instance groups in a cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstances_InstanceGroups
-Instances_KeepJobFlowAliveWhenNoStep <Boolean>
Specifies whether the cluster should remain available after completing all steps. Defaults to false. For more information about configuring cluster termination, see Control Cluster Termination in the EMR Management Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstances_KeepJobFlowAliveWhenNoSteps
-Instances_MasterInstanceType <String>
The Amazon EC2 instance type of the master node.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Instances_Placement_AvailabilityZone <String>
The Amazon EC2 Availability Zone for the cluster. AvailabilityZone is used for uniform instance groups, while AvailabilityZones (plural) is used for instance fleets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Instances_Placement_AvailabilityZones <String[]>
When multiple Availability Zones are specified, Amazon EMR evaluates them and launches instances in the optimal Availability Zone. AvailabilityZones is used for instance fleets, while AvailabilityZone (singular) is used for uniform instance groups.The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Instances_ServiceAccessSecurityGroup <String>
The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Instances_SlaveInstanceType <String>
The Amazon EC2 instance type of the core and task nodes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Instances_TerminationProtected <Boolean>
Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job-flow error.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Instances_UnhealthyNodeReplacement <Boolean>
Indicates whether Amazon EMR should gracefully replace core nodes that have degraded within the cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobFlowRole <String>
Also called instance profile and Amazon EC2 role. An IAM role for an Amazon EMR cluster. The Amazon EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole. In order to use the default role, you must have already created it using the CLI or console.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KerberosAttributes_ADDomainJoinPassword <String>
The Active Directory password for ADDomainJoinUser.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KerberosAttributes_ADDomainJoinUser <String>
Required only when establishing a cross-realm trust with an Active Directory domain. A user with sufficient privileges to join resources to the domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KerberosAttributes_CrossRealmTrustPrincipalPassword <String>
Required only when establishing a cross-realm trust with a KDC in a different realm. The cross-realm principal password, which must be identical across realms.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KerberosAttributes_KdcAdminPassword <String>
The password used within the cluster for the kadmin service on the cluster-dedicated KDC, which maintains Kerberos principals, password policies, and keytabs for the cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KerberosAttributes_Realm <String>
The name of the Kerberos realm to which all nodes in a cluster belong. For example, EC2.INTERNAL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LogEncryptionKmsKeyId <String>
The KMS key used for encrypting log files. If a value is not provided, the logs remain encrypted by AES-256. This attribute is only available with Amazon EMR releases 5.30.0 and later, excluding Amazon EMR 6.0.0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LogUri <String>
The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.
Required?False
Position?2
Accept pipeline input?True (ByPropertyName)
-Name <String>
The name of the job flow.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-NewSupportedProduct <SupportedProductConfig[]>
For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see "Launch a Job Flow on the MapR Distribution for Hadoop" in the Amazon EMR Developer Guide. Supported values are:
  • "mapr-m3" - launch the cluster using MapR M3 Edition.
  • "mapr-m5" - launch the cluster using MapR M5 Edition.
  • "mapr" with the user arguments specifying "--edition,m3" or "--edition,m5" - launch the job flow using MapR M3 or M5 Edition respectively.
  • "mapr-m7" - launch the cluster using MapR M7 Edition.
  • "hunk" - launch the cluster with the Hunk Big Data Analytics Platform.
  • "hue"- launch the cluster with Hue installed.
  • "spark" - launch the cluster with Apache Spark installed.
  • "ganglia" - launch the cluster with the Ganglia Monitoring System installed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNewSupportedProducts
-OSReleaseLabel <String>
Specifies a particular Amazon Linux release for all nodes in a cluster launch RunJobFlow request. If a release is not specified, Amazon EMR uses the latest validated Amazon Linux release for cluster launch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PlacementGroupConfig <PlacementGroupConfig[]>
The specified placement group configuration for an Amazon EMR cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPlacementGroupConfigs
-ReleaseLabel <String>
The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RepoUpgradeOnBoot <RepoUpgradeOnBoot>
Applies only when CustomAmiID is used. Specifies which updates from the Amazon Linux AMI package repositories to apply automatically when the instance boots using the AMI. If omitted, the default is SECURITY, which indicates that only security updates are applied. If NONE is specified, no updates are applied, and all updates must be applied manually.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScaleDownBehavior <ScaleDownBehavior>
Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityConfiguration <String>
The name of a security configuration to apply to the cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'JobFlowId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticMapReduce.Model.RunJobFlowResponse). Specifying the name of a property of type Amazon.ElasticMapReduce.Model.RunJobFlowResponse 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 IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf. If you've created a custom service role path, you must specify it for the service role when you launch your cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Step <StepConfig[]>
A list of steps to run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSteps
-StepConcurrencyLevel <Int32>
Specifies the number of steps that can be executed concurrently. The default value is 1. The maximum value is 256.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SupportedProduct <String[]>
For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.A list of strings that indicates third-party software to use. For more information, see the Amazon EMR Developer Guide. Currently supported values are:
  • "mapr-m3" - launch the job flow using MapR M3 Edition.
  • "mapr-m5" - launch the job flow using MapR M5 Edition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSupportedProducts
-Tag <Tag[]>
A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-VisibleToAllUser <Boolean>
The VisibleToAllUsers parameter is no longer supported. By default, the value is set to true. Setting it to false now has no effect.Set this value to true so that IAM principals in the Amazon Web Services account associated with the cluster can perform Amazon EMR actions on the cluster that their IAM policies allow. This value defaults to true for clusters created using the Amazon EMR API or the CLI create-cluster command.When set to false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions for the cluster, regardless of the IAM permissions policies attached to other IAM principals. For more information, see Understanding the Amazon EMR cluster VisibleToAllUsers setting in the Amazon EMR Management Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVisibleToAllUsers

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.RunJobFlowResponse
This cmdlet returns a System.String object. The service call response (type Amazon.ElasticMapReduce.Model.RunJobFlowResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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