Amazon EMR is a web service that makes it easier to process large amounts of data efficiently. Amazon EMR uses Hadoop processing combined with several Amazon Web Services services to do tasks such as web indexing, data mining, log file analysis, machine learning, scientific simulation, and data warehouse management.
', 'operations' => [ 'AddInstanceFleet' => 'Adds an instance fleet to a running cluster.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x.
Adds one or more instance groups to a running cluster.
', 'AddJobFlowSteps' => 'AddJobFlowSteps adds new steps to a running cluster. 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 SSH to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop.
A step specifies the location of a JAR file stored either on the master node of the cluster or in Amazon S3. Each step is performed by the main function of the main class of the JAR file. The main class can be specified either in the manifest of the JAR or by using the MainFunction parameter of the step.
Amazon EMR executes each step in the order listed. For a step to be considered complete, the main function must exit with a zero exit code and all Hadoop jobs started while the step was running must have completed and run successfully.
You can only add steps to a cluster that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING.
The string values passed into HadoopJarStep object cannot exceed a total of 10240 characters.
Adds tags to an Amazon EMR resource, such as a cluster or an Amazon EMR Studio. Tags make it easier to associate resources in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters.
', 'CancelSteps' => 'Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee that a step will be canceled, even if the request is successfully submitted. When you use Amazon EMR releases 5.28.0 and later, you can cancel steps that are in a PENDING or RUNNING state. In earlier versions of Amazon EMR, you can only cancel steps that are in a PENDING state.
Creates a security configuration, which is stored in the service and can be specified when a cluster is created.
', 'CreateStudio' => 'Creates a new Amazon EMR Studio.
', 'CreateStudioSessionMapping' => 'Maps a user or group to the Amazon EMR Studio specified by StudioId, and applies a session policy to refine Studio permissions for that user or group. Use CreateStudioSessionMapping to assign users to a Studio when you use IAM Identity Center authentication. For instructions on how to assign users to a Studio when you use IAM authentication, see Assign a user or group to your EMR Studio.
Deletes a security configuration.
', 'DeleteStudio' => 'Removes an Amazon EMR Studio from the Studio metadata store.
', 'DeleteStudioSessionMapping' => 'Removes a user or group from an Amazon EMR Studio.
', 'DescribeCluster' => 'Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.
', 'DescribeJobFlows' => 'This API is no longer supported and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead.
DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time.
Regardless of supplied parameters, only job flows created within the last two months are returned.
If no parameters are supplied, then job flows matching either of the following criteria are returned:
Job flows created and completed in the last two weeks
Job flows created within the last two months that are in one of the following states: RUNNING, WAITING, SHUTTING_DOWN, STARTING
Amazon EMR can return a maximum of 512 job flow descriptions.
', 'DescribeNotebookExecution' => 'Provides details of a notebook execution.
', 'DescribeReleaseLabel' => 'Provides Amazon EMR release label details, such as the releases available the Region where the API request is run, and the available applications for a specific Amazon EMR release label. Can also list Amazon EMR releases that support a specified version of Spark.
', 'DescribeSecurityConfiguration' => 'Provides the details of a security configuration by returning the configuration JSON.
', 'DescribeStep' => 'Provides more detail about the cluster step.
', 'DescribeStudio' => 'Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on.
', 'GetAutoTerminationPolicy' => 'Returns the auto-termination policy for an Amazon EMR cluster.
', 'GetBlockPublicAccessConfiguration' => 'Returns the Amazon EMR block public access configuration for your Amazon Web Services account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide.
', 'GetClusterSessionCredentials' => 'Provides temporary, HTTP basic credentials that are associated with a given runtime IAM role and used by a cluster with fine-grained access control activated. You can use these credentials to connect to cluster endpoints that support username and password authentication.
', 'GetManagedScalingPolicy' => 'Fetches the attached managed scaling policy for an Amazon EMR cluster.
', 'GetStudioSessionMapping' => 'Fetches mapping details for the specified Amazon EMR Studio and identity (user or group).
', 'ListBootstrapActions' => 'Provides information about the bootstrap actions associated with a cluster.
', 'ListClusters' => 'Provides the status of all clusters visible to this Amazon Web Services account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters in unsorted order per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls.
', 'ListInstanceFleets' => 'Lists all available details about the instance fleets in a cluster.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
Provides all available details about the instance groups in a cluster.
', 'ListInstances' => 'Provides information for all active Amazon EC2 instances and Amazon EC2 instances terminated in the last 30 days, up to a maximum of 2,000. Amazon EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING.
', 'ListNotebookExecutions' => 'Provides summaries of all notebook executions. You can filter the list based on multiple criteria such as status, time range, and editor id. Returns a maximum of 50 notebook executions and a marker to track the paging of a longer notebook execution list across multiple ListNotebookExecutions calls.
Retrieves release labels of Amazon EMR services in the Region where the API is called.
', 'ListSecurityConfigurations' => 'Lists all the security configurations visible to this account, providing their creation dates and times, and their names. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListSecurityConfigurations calls.
', 'ListSteps' => 'Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request or filter by StepStates. You can specify a maximum of 10 stepIDs. The CLI automatically paginates results to return a list greater than 50 steps. To return more than 50 steps using the CLI, specify a Marker, which is a pagination token that indicates the next set of steps to retrieve.
Returns a list of all user or group session mappings for the Amazon EMR Studio specified by StudioId.
Returns a list of all Amazon EMR Studios associated with the Amazon Web Services account. The list includes details such as ID, Studio Access URL, and creation time for each Studio.
', 'ListSupportedInstanceTypes' => 'A list of the instance types that Amazon EMR supports. You can filter the list by Amazon Web Services Region and Amazon EMR release.
', 'ModifyCluster' => 'Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.
', 'ModifyInstanceFleet' => 'Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetID within the cluster specified using ClusterID. The call either succeeds or fails atomically.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group. The input parameters include the new target instance count for the group and the instance group ID. The call will either succeed or fail atomically.
', 'PutAutoScalingPolicy' => 'Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric.
', 'PutAutoTerminationPolicy' => 'Auto-termination is supported in Amazon EMR releases 5.30.0 and 6.1.0 and later. For more information, see Using an auto-termination policy.
Creates or updates an auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.
', 'PutBlockPublicAccessConfiguration' => 'Creates or updates an Amazon EMR block public access configuration for your Amazon Web Services account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide.
', 'PutManagedScalingPolicy' => 'Creates or updates a managed scaling policy for an Amazon EMR cluster. The managed scaling policy defines the limits for resources, such as Amazon EC2 instances that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
', 'RemoveAutoScalingPolicy' => 'Removes an automatic scaling policy from a specified instance group within an Amazon EMR cluster.
', 'RemoveAutoTerminationPolicy' => 'Removes an auto-termination policy from an Amazon EMR cluster.
', 'RemoveManagedScalingPolicy' => 'Removes a managed scaling policy from a specified Amazon EMR cluster.
', 'RemoveTags' => 'Removes tags from an Amazon EMR resource, such as a cluster or Amazon EMR Studio. Tags make it easier to associate resources in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters.
The following example removes the stack tag with value Prod from a cluster:
', 'RunJobFlow' => '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 JobFlowInstancesConfig KeepJobFlowAliveWhenNoSteps 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 JobFlowInstancesConfig TerminationProtected 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.
SetTerminationProtection locks a cluster (job flow) so the Amazon EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error. The cluster still terminates upon successful completion of the job flow. Calling SetTerminationProtection on a cluster is similar to calling the Amazon EC2 DisableAPITermination API on all Amazon EC2 instances in a cluster.
SetTerminationProtection is used to prevent accidental termination of a cluster and to ensure that in the event of an error, the instances persist so that you can recover any data stored in their ephemeral instance storage.
To terminate a cluster that has been locked by setting SetTerminationProtection to true, you must first unlock the job flow by a subsequent call to SetTerminationProtection in which you set the value to false.
For more information, seeManaging Cluster Termination in the Amazon EMR Management Guide.
', 'SetVisibleToAllUsers' => 'The SetVisibleToAllUsers parameter is no longer supported. Your cluster may be visible to all users in your account. To restrict cluster access using an IAM policy, see Identity and Access Management for Amazon EMR.
Sets the Cluster$VisibleToAllUsers value for an Amazon EMR cluster. When true, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions on the cluster, regardless of IAM permissions policies attached to other IAM principals.
This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter.
For more information, see Understanding the Amazon EMR Cluster VisibleToAllUsers Setting in the Amazon EMR Management Guide.
', 'StartNotebookExecution' => 'Starts a notebook execution.
', 'StopNotebookExecution' => 'Stops a notebook execution.
', 'TerminateJobFlows' => 'TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut down, any step not yet completed is canceled and the Amazon EC2 instances on which the cluster is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the cluster was created.
The maximum number of clusters allowed is 10. The call to TerminateJobFlows is asynchronous. Depending on the configuration of the cluster, it may take up to 1-5 minutes for the cluster to completely terminate and release allocated resources, such as Amazon EC2 instances.
Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets.
', 'UpdateStudioSessionMapping' => 'Updates the session policy attached to the user or group for the specified Amazon EMR Studio.
', ], 'shapes' => [ 'ActionOnFailure' => [ 'base' => NULL, 'refs' => [ 'Step$ActionOnFailure' => 'The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead.
If a cluster\'s StepConcurrencyLevel is greater than 1, do not use AddJobFlowSteps to submit a step with this parameter set to CANCEL_AND_WAIT or TERMINATE_CLUSTER. The step is not submitted and the action fails with a message that the ActionOnFailure setting is not valid.
If you change a cluster\'s StepConcurrencyLevel to be greater than 1 while a step is running, the ActionOnFailure parameter may not behave as you expect. In this case, for a step that fails with this parameter set to CANCEL_AND_WAIT, pending steps and the running step are not canceled; for a step that fails with this parameter set to TERMINATE_CLUSTER, the cluster does not terminate.
The action to take when the step fails. Use one of the following values:
TERMINATE_CLUSTER - Shuts down the cluster.
CANCEL_AND_WAIT - Cancels any pending steps and returns the cluster to the WAITING state.
CONTINUE - Continues to the next step in the queue.
TERMINATE_JOB_FLOW - Shuts down the cluster. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead.
If a cluster\'s StepConcurrencyLevel is greater than 1, do not use AddJobFlowSteps to submit a step with this parameter set to CANCEL_AND_WAIT or TERMINATE_CLUSTER. The step is not submitted and the action fails with a message that the ActionOnFailure setting is not valid.
If you change a cluster\'s StepConcurrencyLevel to be greater than 1 while a step is running, the ActionOnFailure parameter may not behave as you expect. In this case, for a step that fails with this parameter set to CANCEL_AND_WAIT, pending steps and the running step are not canceled; for a step that fails with this parameter set to TERMINATE_CLUSTER, the cluster does not terminate.
The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is available for backward compatibility.
', ], ], 'AddInstanceFleetInput' => [ 'base' => NULL, 'refs' => [], ], 'AddInstanceFleetOutput' => [ 'base' => NULL, 'refs' => [], ], 'AddInstanceGroupsInput' => [ 'base' => 'Input to an AddInstanceGroups call.
', 'refs' => [], ], 'AddInstanceGroupsOutput' => [ 'base' => 'Output from an AddInstanceGroups call.
', 'refs' => [], ], 'AddJobFlowStepsInput' => [ 'base' => 'The input argument to the AddJobFlowSteps operation.
', 'refs' => [], ], 'AddJobFlowStepsOutput' => [ 'base' => 'The output for the AddJobFlowSteps operation.
', 'refs' => [], ], 'AddTagsInput' => [ 'base' => 'This input identifies an Amazon EMR resource and a list of tags to attach.
', 'refs' => [], ], 'AddTagsOutput' => [ 'base' => 'This output indicates the result of adding tags to a resource.
', 'refs' => [], ], 'AdjustmentType' => [ 'base' => NULL, 'refs' => [ 'SimpleScalingPolicyConfiguration$AdjustmentType' => 'The way in which Amazon EC2 instances are added (if ScalingAdjustment is a positive number) or terminated (if ScalingAdjustment is a negative number) each time the scaling activity is triggered. CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that the Amazon EC2 instance count increments or decrements by ScalingAdjustment, which should be expressed as an integer. PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments or decrements by the percentage specified by ScalingAdjustment, which should be expressed as an integer. For example, 20 indicates an increase in 20% increments of cluster capacity. EXACT_CAPACITY indicates the scaling activity results in an instance group with the number of Amazon EC2 instances specified by ScalingAdjustment, which should be expressed as a positive integer.
With Amazon EMR release version 4.0 and later, the only accepted parameter is the application name. To pass arguments to applications, you use configuration classifications specified using configuration JSON objects. For more information, see Configuring Applications.
With earlier Amazon EMR releases, the application is any Amazon or third-party software that you can add to the cluster. This structure contains a list of strings that indicates the software to use with the cluster and accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action argument.
', 'refs' => [ 'ApplicationList$member' => NULL, ], ], 'ApplicationList' => [ 'base' => NULL, 'refs' => [ 'Cluster$Applications' => 'The applications installed on this cluster.
', 'RunJobFlowInput$Applications' => '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.
', ], ], 'ArnType' => [ 'base' => NULL, 'refs' => [ 'AddInstanceFleetOutput$ClusterArn' => 'The Amazon Resource Name of the cluster.
', 'AddInstanceGroupsOutput$ClusterArn' => 'The Amazon Resource Name of the cluster.
', 'AddJobFlowStepsInput$ExecutionRoleArn' => 'The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format: arn:partition:service:region:account:resource.
For example, arn:aws:IAM::1234567890:role/ReadOnly is a correctly formatted runtime role ARN.
The Amazon Resource Name that created or last modified the configuration.
', 'Cluster$ClusterArn' => 'The Amazon Resource Name of the cluster.
', 'ClusterSummary$ClusterArn' => 'The Amazon Resource Name of the cluster.
', 'GetClusterSessionCredentialsInput$ExecutionRoleArn' => 'The Amazon Resource Name (ARN) of the runtime role for interactive workload submission on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format: arn:partition:service:region:account:resource.
The Amazon Resource Name (ARN) of the cluster.
', 'RunJobFlowOutput$ClusterArn' => 'The Amazon Resource Name (ARN) of the cluster.
', ], ], 'AuthMode' => [ 'base' => NULL, 'refs' => [ 'CreateStudioInput$AuthMode' => 'Specifies whether the Studio authenticates users using IAM or IAM Identity Center.
', 'Studio$AuthMode' => 'Specifies whether the Amazon EMR Studio authenticates users with IAM or IAM Identity Center.
', 'StudioSummary$AuthMode' => 'Specifies whether the Studio authenticates users using IAM or IAM Identity Center.
', ], ], 'AutoScalingPolicy' => [ 'base' => 'An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. An automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
', 'refs' => [ 'InstanceGroupConfig$AutoScalingPolicy' => 'An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
', 'PutAutoScalingPolicyInput$AutoScalingPolicy' => 'Specifies the definition of the automatic scaling policy.
', ], ], 'AutoScalingPolicyDescription' => [ 'base' => 'An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
', 'refs' => [ 'InstanceGroup$AutoScalingPolicy' => 'An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
', 'PutAutoScalingPolicyOutput$AutoScalingPolicy' => 'The automatic scaling policy definition.
', ], ], 'AutoScalingPolicyState' => [ 'base' => NULL, 'refs' => [ 'AutoScalingPolicyStatus$State' => 'Indicates the status of the automatic scaling policy.
', ], ], 'AutoScalingPolicyStateChangeReason' => [ 'base' => 'The reason for an AutoScalingPolicyStatus change.
', 'refs' => [ 'AutoScalingPolicyStatus$StateChangeReason' => 'The reason for a change in status.
', ], ], 'AutoScalingPolicyStateChangeReasonCode' => [ 'base' => NULL, 'refs' => [ 'AutoScalingPolicyStateChangeReason$Code' => 'The code indicating the reason for the change in status.USER_REQUEST indicates that the scaling policy status was changed by a user. PROVISION_FAILURE indicates that the status change was because the policy failed to provision. CLEANUP_FAILURE indicates an error.
The status of an automatic scaling policy.
', 'refs' => [ 'AutoScalingPolicyDescription$Status' => 'The status of an automatic scaling policy.
', ], ], 'AutoTerminationPolicy' => [ 'base' => 'An auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.
', 'refs' => [ 'GetAutoTerminationPolicyOutput$AutoTerminationPolicy' => 'Specifies the auto-termination policy that is attached to an Amazon EMR cluster.
', 'PutAutoTerminationPolicyInput$AutoTerminationPolicy' => 'Specifies the auto-termination policy to attach to the cluster.
', 'RunJobFlowInput$AutoTerminationPolicy' => NULL, ], ], 'BlockPublicAccessConfiguration' => [ 'base' => 'A configuration for Amazon EMR block public access. When BlockPublicSecurityGroupRules is set to true, Amazon EMR prevents cluster creation if one of the cluster\'s security groups has a rule that allows inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges.
A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges in the BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating the block public access configuration to remove the exception.
For accounts that created clusters in a Region before November 25, 2019, block public access is disabled by default in that Region. To use this feature, you must manually enable and configure it. For accounts that did not create an Amazon EMR cluster in a Region before this date, block public access is enabled by default in that Region.
A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges in the BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating BlockPublicSecurityGroupRules to remove the exception.
For accounts that created clusters in a Region before November 25, 2019, block public access is disabled by default in that Region. To use this feature, you must manually enable and configure it. For accounts that did not create an Amazon EMR cluster in a Region before this date, block public access is enabled by default in that Region.
Properties that describe the Amazon Web Services principal that created the BlockPublicAccessConfiguration using the PutBlockPublicAccessConfiguration action as well as the date and time that the configuration was created. Each time a configuration for block public access is updated, Amazon EMR updates this metadata.
Properties that describe the Amazon Web Services principal that created the BlockPublicAccessConfiguration using the PutBlockPublicAccessConfiguration action as well as the date and time that the configuration was created. Each time a configuration for block public access is updated, Amazon EMR updates this metadata.
Indicates whether Amazon EMR block public access is enabled (true) or disabled (false). By default, the value is false for accounts that have created Amazon EMR clusters before July 2019. For accounts created after this, the default is true.
Specifies whether the cluster should terminate after completing all steps.
', 'Cluster$TerminationProtected' => 'Indicates whether Amazon EMR will lock the cluster to prevent the Amazon EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.
', 'Cluster$VisibleToAllUsers' => 'Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions on the cluster that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions, regardless of IAM permissions policies attached to other IAM principals.
The default value is true if a value is not provided when creating a cluster using the Amazon EMR API RunJobFlow command, the CLI create-cluster command, or the Amazon Web Services Management Console.
Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions, regardless of IAM permissions policies attached to other IAM principals.
The default value is true if a value is not provided when creating a cluster using the Amazon EMR API RunJobFlow command, the CLI create-cluster command, or the Amazon Web Services Management Console.
Specifies whether the cluster should remain available after completing all steps. Defaults to true. For more information about configuring cluster termination, see Control Cluster Termination in the EMR Management Guide.
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.
', 'JobFlowInstancesDetail$KeepJobFlowAliveWhenNoSteps' => 'Specifies whether the cluster should remain available after completing all steps.
', 'JobFlowInstancesDetail$TerminationProtected' => 'Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job-flow error.
', 'RunJobFlowInput$VisibleToAllUsers' => '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.
A Boolean that indicates whether to protect the cluster and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.
', 'SetVisibleToAllUsersInput$VisibleToAllUsers' => 'A value of true indicates that an IAM principal in the Amazon Web Services account can perform Amazon EMR actions on the cluster that the IAM policies attached to the principal allow. A value of false indicates that only the IAM principal that created the cluster and the Amazon Web Services root user can perform Amazon EMR actions on the cluster.
Indicates whether the SupportedInstanceType only supports 64-bit architecture.
Indicates whether the SupportedInstanceType supports Amazon EBS optimization.
Indicates whether the SupportedInstanceType uses Amazon EBS optimization by default.
Indicates whether the SupportedInstanceType only supports Amazon EBS.
Indicates whether an Amazon EBS volume is EBS-optimized.
', 'InstanceGroup$EbsOptimized' => 'If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.
', 'InstanceTypeSpecification$EbsOptimized' => 'Evaluates to TRUE when the specified InstanceType is EBS-optimized.
Configuration of a bootstrap action.
', 'refs' => [ 'BootstrapActionConfigList$member' => NULL, 'BootstrapActionDetail$BootstrapActionConfig' => 'A description of the bootstrap action.
', ], ], 'BootstrapActionConfigList' => [ 'base' => NULL, 'refs' => [ 'RunJobFlowInput$BootstrapActions' => 'A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
', ], ], 'BootstrapActionDetail' => [ 'base' => 'Reports the configuration of a bootstrap action in a cluster (job flow).
', 'refs' => [ 'BootstrapActionDetailList$member' => NULL, ], ], 'BootstrapActionDetailList' => [ 'base' => NULL, 'refs' => [ 'JobFlowDetail$BootstrapActions' => 'A list of the bootstrap actions run by the job flow.
', ], ], 'CancelStepsInfo' => [ 'base' => 'Specification of the status of a CancelSteps request. Available only in Amazon EMR version 4.8.0 and later, excluding version 5.0.0.
', 'refs' => [ 'CancelStepsInfoList$member' => NULL, ], ], 'CancelStepsInfoList' => [ 'base' => NULL, 'refs' => [ 'CancelStepsOutput$CancelStepsInfoList' => 'A list of CancelStepsInfo, which shows the status of specified cancel requests for each StepID specified.
The input argument to the CancelSteps operation.
', 'refs' => [], ], 'CancelStepsOutput' => [ 'base' => 'The output for the CancelSteps operation.
', 'refs' => [], ], 'CancelStepsRequestStatus' => [ 'base' => NULL, 'refs' => [ 'CancelStepsInfo$Status' => 'The status of a CancelSteps Request. The value may be SUBMITTED or FAILED.
', ], ], 'CloudWatchAlarmDefinition' => [ 'base' => 'The definition of a CloudWatch metric alarm, which determines when an automatic scaling activity is triggered. When the defined alarm conditions are satisfied, scaling activity begins.
', 'refs' => [ 'ScalingTrigger$CloudWatchAlarmDefinition' => 'The definition of a CloudWatch metric alarm. When the defined alarm conditions are met along with other trigger parameters, scaling activity begins.
', ], ], 'Cluster' => [ 'base' => 'The detailed description of the cluster.
', 'refs' => [ 'DescribeClusterOutput$Cluster' => 'This output contains the details for the requested cluster.
', ], ], 'ClusterId' => [ 'base' => NULL, 'refs' => [ 'Cluster$Id' => 'The unique identifier for the cluster.
', 'ClusterSummary$Id' => 'The unique identifier for the cluster.
', 'DescribeClusterInput$ClusterId' => 'The identifier of the cluster to describe.
', 'DescribeStepInput$ClusterId' => 'The identifier of the cluster with steps to describe.
', 'GetAutoTerminationPolicyInput$ClusterId' => 'Specifies the ID of the Amazon EMR cluster for which the auto-termination policy will be fetched.
', 'GetManagedScalingPolicyInput$ClusterId' => 'Specifies the ID of the cluster for which the managed scaling policy will be fetched.
', 'ListBootstrapActionsInput$ClusterId' => 'The cluster identifier for the bootstrap actions to list.
', 'ListInstanceFleetsInput$ClusterId' => 'The unique identifier of the cluster.
', 'ListInstanceGroupsInput$ClusterId' => 'The identifier of the cluster for which to list the instance groups.
', 'ListInstancesInput$ClusterId' => 'The identifier of the cluster for which to list the instances.
', 'ListStepsInput$ClusterId' => 'The identifier of the cluster for which to list the steps.
', 'ModifyInstanceFleetInput$ClusterId' => 'The unique identifier of the cluster.
', 'ModifyInstanceGroupsInput$ClusterId' => 'The ID of the cluster to which the instance group belongs.
', 'PutAutoScalingPolicyInput$ClusterId' => 'Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
', 'PutAutoScalingPolicyOutput$ClusterId' => 'Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
', 'PutAutoTerminationPolicyInput$ClusterId' => 'Specifies the ID of the Amazon EMR cluster to which the auto-termination policy will be attached.
', 'PutManagedScalingPolicyInput$ClusterId' => 'Specifies the ID of an Amazon EMR cluster where the managed scaling policy is attached.
', 'RemoveAutoScalingPolicyInput$ClusterId' => 'Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
', 'RemoveAutoTerminationPolicyInput$ClusterId' => 'Specifies the ID of the Amazon EMR cluster from which the auto-termination policy will be removed.
', 'RemoveManagedScalingPolicyInput$ClusterId' => 'Specifies the ID of the cluster from which the managed scaling policy will be removed.
', ], ], 'ClusterState' => [ 'base' => NULL, 'refs' => [ 'ClusterStateList$member' => NULL, 'ClusterStatus$State' => 'The current state of the cluster.
', ], ], 'ClusterStateChangeReason' => [ 'base' => 'The reason that the cluster changed to its current state.
', 'refs' => [ 'ClusterStatus$StateChangeReason' => 'The reason for the cluster status change.
', ], ], 'ClusterStateChangeReasonCode' => [ 'base' => NULL, 'refs' => [ 'ClusterStateChangeReason$Code' => 'The programmatic code for the state change reason.
', ], ], 'ClusterStateList' => [ 'base' => NULL, 'refs' => [ 'ListClustersInput$ClusterStates' => 'The cluster state filters to apply when listing clusters. Clusters that change state while this action runs may be not be returned as expected in the list of clusters.
', ], ], 'ClusterStatus' => [ 'base' => 'The detailed status of the cluster.
', 'refs' => [ 'Cluster$Status' => 'The current status details about the cluster.
', 'ClusterSummary$Status' => 'The details about the current status of the cluster.
', ], ], 'ClusterSummary' => [ 'base' => 'The summary description of the cluster.
', 'refs' => [ 'ClusterSummaryList$member' => NULL, ], ], 'ClusterSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListClustersOutput$Clusters' => 'The list of clusters for the account based on the given filters.
', ], ], 'ClusterTimeline' => [ 'base' => 'Represents the timeline of the cluster\'s lifecycle.
', 'refs' => [ 'ClusterStatus$Timeline' => 'A timeline that represents the status of a cluster over the lifetime of the cluster.
', ], ], 'Command' => [ 'base' => 'An entity describing an executable that runs on a cluster.
', 'refs' => [ 'CommandList$member' => NULL, ], ], 'CommandList' => [ 'base' => NULL, 'refs' => [ 'ListBootstrapActionsOutput$BootstrapActions' => 'The bootstrap actions associated with the cluster.
', ], ], 'ComparisonOperator' => [ 'base' => NULL, 'refs' => [ 'CloudWatchAlarmDefinition$ComparisonOperator' => 'Determines how the metric specified by MetricName is compared to the value specified by Threshold.
The Amazon EC2 unit limits for a managed scaling policy. The managed scaling activity of a cluster can not be above or below these limits. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
', 'refs' => [ 'ManagedScalingPolicy$ComputeLimits' => 'The Amazon EC2 unit limits for a managed scaling policy. The managed scaling activity of a cluster is not allowed to go above or below these limits. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
', ], ], 'ComputeLimitsUnitType' => [ 'base' => NULL, 'refs' => [ 'ComputeLimits$UnitType' => 'The unit type used for specifying a managed scaling policy.
', ], ], 'Configuration' => [ 'base' => 'Amazon EMR releases 4.x or later.
An optional configuration specification to be used when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. For more information, see Configuring Applications.
', 'refs' => [ 'ConfigurationList$member' => NULL, ], ], 'ConfigurationList' => [ 'base' => NULL, 'refs' => [ 'Cluster$Configurations' => 'Applies only to Amazon EMR releases 4.x and later. The list of configurations that are supplied to the Amazon EMR cluster.
', 'Configuration$Configurations' => 'A list of additional configurations to apply within a configuration object.
', 'InstanceGroup$Configurations' => 'Amazon EMR releases 4.x or later.
The list of configurations supplied for an Amazon EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
', 'InstanceGroup$LastSuccessfullyAppliedConfigurations' => 'A list of configurations that were successfully applied for an instance group last time.
', 'InstanceGroupConfig$Configurations' => 'Amazon EMR releases 4.x or later.
The list of configurations supplied for an Amazon EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
', 'InstanceGroupModifyConfig$Configurations' => 'A list of new or modified configurations to apply for an instance group.
', 'InstanceTypeConfig$Configurations' => 'A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software that run on the cluster.
', 'InstanceTypeSpecification$Configurations' => 'A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR.
', 'RunJobFlowInput$Configurations' => 'For Amazon EMR releases 4.0 and later. The list of configurations supplied for the Amazon EMR cluster that you are creating.
', ], ], 'CreateSecurityConfigurationInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateSecurityConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioSessionMappingInput' => [ 'base' => NULL, 'refs' => [], ], 'Credentials' => [ 'base' => 'The credentials that you can use to connect to cluster endpoints. Credentials consist of a username and a password.
', 'refs' => [ 'GetClusterSessionCredentialsOutput$Credentials' => 'The credentials that you can use to connect to cluster endpoints that support username and password authentication.
', ], ], 'Date' => [ 'base' => NULL, 'refs' => [ 'BlockPublicAccessConfigurationMetadata$CreationDateTime' => 'The date and time that the configuration was created.
', 'ClusterTimeline$CreationDateTime' => 'The creation date and time of the cluster.
', 'ClusterTimeline$ReadyDateTime' => 'The date and time when the cluster was ready to run steps.
', 'ClusterTimeline$EndDateTime' => 'The date and time when the cluster was terminated.
', 'CreateSecurityConfigurationOutput$CreationDateTime' => 'The date and time the security configuration was created.
', 'DescribeJobFlowsInput$CreatedAfter' => 'Return only job flows created after this date and time.
', 'DescribeJobFlowsInput$CreatedBefore' => 'Return only job flows created before this date and time.
', 'DescribeSecurityConfigurationOutput$CreationDateTime' => 'The date and time the security configuration was created
', 'GetClusterSessionCredentialsOutput$ExpiresAt' => 'The time when the credentials that are returned by the GetClusterSessionCredentials API expire.
The time and date the instance fleet was created.
', 'InstanceFleetTimeline$ReadyDateTime' => 'The time and date the instance fleet was ready to run jobs.
', 'InstanceFleetTimeline$EndDateTime' => 'The time and date the instance fleet terminated.
', 'InstanceGroupDetail$CreationDateTime' => 'The date/time the instance group was created.
', 'InstanceGroupDetail$StartDateTime' => 'The date/time the instance group was started.
', 'InstanceGroupDetail$ReadyDateTime' => 'The date/time the instance group was available to the cluster.
', 'InstanceGroupDetail$EndDateTime' => 'The date/time the instance group was terminated.
', 'InstanceGroupTimeline$CreationDateTime' => 'The creation date and time of the instance group.
', 'InstanceGroupTimeline$ReadyDateTime' => 'The date and time when the instance group became ready to perform tasks.
', 'InstanceGroupTimeline$EndDateTime' => 'The date and time when the instance group terminated.
', 'InstanceTimeline$CreationDateTime' => 'The creation date and time of the instance.
', 'InstanceTimeline$ReadyDateTime' => 'The date and time when the instance was ready to perform tasks.
', 'InstanceTimeline$EndDateTime' => 'The date and time when the instance was terminated.
', 'JobFlowExecutionStatusDetail$CreationDateTime' => 'The creation date and time of the job flow.
', 'JobFlowExecutionStatusDetail$StartDateTime' => 'The start date and time of the job flow.
', 'JobFlowExecutionStatusDetail$ReadyDateTime' => 'The date and time when the job flow was ready to start running bootstrap actions.
', 'JobFlowExecutionStatusDetail$EndDateTime' => 'The completion date and time of the job flow.
', 'ListClustersInput$CreatedAfter' => 'The creation date and time beginning value filter for listing clusters.
', 'ListClustersInput$CreatedBefore' => 'The creation date and time end value filter for listing clusters.
', 'ListNotebookExecutionsInput$From' => 'The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.
', 'ListNotebookExecutionsInput$To' => 'The end of time range filter for listing notebook executions. The default is the current timestamp.
', 'NotebookExecution$StartTime' => 'The timestamp when notebook execution started.
', 'NotebookExecution$EndTime' => 'The timestamp when notebook execution ended.
', 'NotebookExecutionSummary$StartTime' => 'The timestamp when notebook execution started.
', 'NotebookExecutionSummary$EndTime' => 'The timestamp when notebook execution started.
', 'SecurityConfigurationSummary$CreationDateTime' => 'The date and time the security configuration was created.
', 'SessionMappingDetail$CreationTime' => 'The time the session mapping was created.
', 'SessionMappingDetail$LastModifiedTime' => 'The time the session mapping was last modified.
', 'SessionMappingSummary$CreationTime' => 'The time the session mapping was created.
', 'StepExecutionStatusDetail$CreationDateTime' => 'The creation date and time of the step.
', 'StepExecutionStatusDetail$StartDateTime' => 'The start date and time of the step.
', 'StepExecutionStatusDetail$EndDateTime' => 'The completion date and time of the step.
', 'StepTimeline$CreationDateTime' => 'The date and time when the cluster step was created.
', 'StepTimeline$StartDateTime' => 'The date and time when the cluster step execution started.
', 'StepTimeline$EndDateTime' => 'The date and time when the cluster step execution completed or failed.
', 'Studio$CreationTime' => 'The time the Amazon EMR Studio was created.
', 'StudioSummary$CreationTime' => 'The time when the Amazon EMR Studio was created.
', ], ], 'DeleteSecurityConfigurationInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSecurityConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStudioInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStudioSessionMappingInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClusterInput' => [ 'base' => 'This input determines which cluster to describe.
', 'refs' => [], ], 'DescribeClusterOutput' => [ 'base' => 'This output contains the description of the cluster.
', 'refs' => [], ], 'DescribeJobFlowsInput' => [ 'base' => 'The input for the DescribeJobFlows operation.
', 'refs' => [], ], 'DescribeJobFlowsOutput' => [ 'base' => 'The output for the DescribeJobFlows operation.
', 'refs' => [], ], 'DescribeNotebookExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeReleaseLabelInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeReleaseLabelOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSecurityConfigurationInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSecurityConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStepInput' => [ 'base' => 'This input determines which step to describe.
', 'refs' => [], ], 'DescribeStepOutput' => [ 'base' => 'This output contains the description of the cluster step.
', 'refs' => [], ], 'DescribeStudioInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStudioOutput' => [ 'base' => NULL, 'refs' => [], ], 'EC2InstanceIdsList' => [ 'base' => NULL, 'refs' => [ 'InstanceResizePolicy$InstancesToTerminate' => 'Specific list of instances to be terminated when shrinking an instance group.
', 'InstanceResizePolicy$InstancesToProtect' => 'Specific list of instances to be protected when shrinking an instance group.
', ], ], 'EC2InstanceIdsToTerminateList' => [ 'base' => NULL, 'refs' => [ 'InstanceGroupModifyConfig$EC2InstanceIdsToTerminate' => 'The Amazon EC2 InstanceIds to terminate. After you terminate the instances, the instance group will not return to its original requested size.
', ], ], 'EbsBlockDevice' => [ 'base' => 'Configuration of requested EBS block device associated with the instance group.
', 'refs' => [ 'EbsBlockDeviceList$member' => NULL, ], ], 'EbsBlockDeviceConfig' => [ 'base' => 'Configuration of requested EBS block device associated with the instance group with count of volumes that are associated to every instance.
', 'refs' => [ 'EbsBlockDeviceConfigList$member' => NULL, ], ], 'EbsBlockDeviceConfigList' => [ 'base' => NULL, 'refs' => [ 'EbsConfiguration$EbsBlockDeviceConfigs' => 'An array of Amazon EBS volume specifications attached to a cluster instance.
', ], ], 'EbsBlockDeviceList' => [ 'base' => NULL, 'refs' => [ 'InstanceGroup$EbsBlockDevices' => 'The EBS block devices that are mapped to this instance group.
', 'InstanceTypeSpecification$EbsBlockDevices' => 'The configuration of Amazon Elastic Block Store (Amazon EBS) attached to each instance as defined by InstanceType.
The Amazon EBS configuration of a cluster instance.
', 'refs' => [ 'InstanceGroupConfig$EbsConfiguration' => 'EBS configurations that will be attached to each Amazon EC2 instance in the instance group.
', 'InstanceTypeConfig$EbsConfiguration' => 'The configuration of Amazon Elastic Block Store (Amazon EBS) attached to each instance as defined by InstanceType.
EBS block device that\'s attached to an Amazon EC2 instance.
', 'refs' => [ 'EbsVolumeList$member' => NULL, ], ], 'EbsVolumeList' => [ 'base' => NULL, 'refs' => [ 'Instance$EbsVolumes' => 'The list of Amazon EBS volumes that are attached to this instance.
', ], ], 'Ec2InstanceAttributes' => [ 'base' => 'Provides information about the Amazon EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.
', 'refs' => [ 'Cluster$Ec2InstanceAttributes' => 'Provides information about the Amazon EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.
', ], ], 'EnvironmentVariablesMap' => [ 'base' => NULL, 'refs' => [ 'NotebookExecution$EnvironmentVariables' => 'The environment variables associated with the notebook execution.
', 'StartNotebookExecutionInput$EnvironmentVariables' => 'The environment variables associated with the notebook execution.
', ], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'InvalidRequestException$ErrorCode' => 'The error code associated with the exception.
', ], ], 'ErrorData' => [ 'base' => NULL, 'refs' => [ 'ErrorDetail$ErrorData' => 'A list of key value pairs that provides contextual information about why an error occured.
', ], ], 'ErrorDetail' => [ 'base' => 'A tuple that provides information about an error that caused a cluster to terminate.
', 'refs' => [ 'ErrorDetailList$member' => NULL, ], ], 'ErrorDetailList' => [ 'base' => NULL, 'refs' => [ 'ClusterStatus$ErrorDetails' => 'A list of tuples that provides information about the errors that caused a cluster to terminate. This structure can contain up to 10 different ErrorDetail tuples.
The message associated with the exception.
', 'InvalidRequestException$Message' => 'The message associated with the exception.
', ], ], 'ExecutionEngineConfig' => [ 'base' => 'Specifies the execution engine (cluster) to run the notebook and perform the notebook execution, for example, an Amazon EMR cluster.
', 'refs' => [ 'NotebookExecution$ExecutionEngine' => 'The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.
', 'StartNotebookExecutionInput$ExecutionEngine' => 'Specifies the execution engine (cluster) that runs the notebook execution.
', ], ], 'ExecutionEngineType' => [ 'base' => NULL, 'refs' => [ 'ExecutionEngineConfig$Type' => 'The type of execution engine. A value of EMR specifies an Amazon EMR cluster.
The details of the step failure. The service attempts to detect the root cause for many common failures.
', 'refs' => [ 'StepStatus$FailureDetails' => 'The details for the step failure including reason, message, and log file path where the root cause was identified.
', ], ], 'Float' => [ 'base' => NULL, 'refs' => [ 'SupportedInstanceType$MemoryGB' => 'The amount of memory that is available to Amazon EMR from the SupportedInstanceType. The kernel and hypervisor software consume some memory, so this value might be lower than the overall memory for the instance type.
A job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.
', 'refs' => [ 'StepConfig$HadoopJarStep' => 'The JAR file used for the step.
', ], ], 'HadoopStepConfig' => [ 'base' => 'A cluster step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.
', 'refs' => [ 'Step$Config' => 'The Hadoop job configuration of the cluster step.
', 'StepSummary$Config' => 'The Hadoop job configuration of the cluster step.
', ], ], 'IAMRoleArn' => [ 'base' => NULL, 'refs' => [ 'ExecutionEngineConfig$ExecutionRoleArn' => 'The execution role ARN required for the notebook execution.
', ], ], 'IdentityType' => [ 'base' => NULL, 'refs' => [ 'CreateStudioSessionMappingInput$IdentityType' => 'Specifies whether the identity to map to the Amazon EMR Studio is a user or a group.
', 'DeleteStudioSessionMappingInput$IdentityType' => 'Specifies whether the identity to delete from the Amazon EMR Studio is a user or a group.
', 'GetStudioSessionMappingInput$IdentityType' => 'Specifies whether the identity to fetch is a user or a group.
', 'ListStudioSessionMappingsInput$IdentityType' => 'Specifies whether to return session mappings for users or groups. If not specified, the results include session mapping details for both users and groups.
', 'SessionMappingDetail$IdentityType' => 'Specifies whether the identity mapped to the Amazon EMR Studio is a user or a group.
', 'SessionMappingSummary$IdentityType' => 'Specifies whether the identity mapped to the Amazon EMR Studio is a user or a group.
', 'UpdateStudioSessionMappingInput$IdentityType' => 'Specifies whether the identity to update is a user or a group.
', ], ], 'Instance' => [ 'base' => 'Represents an Amazon EC2 instance provisioned as part of cluster.
', 'refs' => [ 'InstanceList$member' => NULL, ], ], 'InstanceCollectionType' => [ 'base' => NULL, 'refs' => [ 'Cluster$InstanceCollectionType' => 'The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.
Describes an instance fleet, which is a group of Amazon EC2 instances that host a particular node type (master, core, or task) in an Amazon EMR cluster. Instance fleets can consist of a mix of instance types and On-Demand and Spot Instances, which are provisioned to meet a defined target capacity.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
The configuration that defines an instance fleet.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
Specifies the configuration of the instance fleet.
', 'InstanceFleetConfigList$member' => NULL, ], ], 'InstanceFleetConfigList' => [ 'base' => NULL, 'refs' => [ 'JobFlowInstancesConfig$InstanceFleets' => '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.
', ], ], 'InstanceFleetId' => [ 'base' => NULL, 'refs' => [ 'AddInstanceFleetOutput$InstanceFleetId' => 'The unique identifier of the instance fleet.
', 'Instance$InstanceFleetId' => 'The unique identifier of the instance fleet to which an Amazon EC2 instance belongs.
', 'InstanceFleet$Id' => 'The unique identifier of the instance fleet.
', 'InstanceFleetModifyConfig$InstanceFleetId' => 'A unique identifier for the instance fleet.
', 'ListInstancesInput$InstanceFleetId' => 'The unique identifier of the instance fleet.
', ], ], 'InstanceFleetList' => [ 'base' => NULL, 'refs' => [ 'ListInstanceFleetsOutput$InstanceFleets' => 'The list of instance fleets for the cluster and given filters.
', ], ], 'InstanceFleetModifyConfig' => [ 'base' => 'Configuration parameters for an instance fleet modification request.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
The configuration parameters of the instance fleet.
', ], ], 'InstanceFleetProvisioningSpecifications' => [ 'base' => 'The launch specification for Spot Instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. On-Demand and Spot instance allocation strategies are available in Amazon EMR releases 5.12.1 and later.
Describes the launch specification for an instance fleet.
', 'InstanceFleetConfig$LaunchSpecifications' => 'The launch specification for the instance fleet.
', ], ], 'InstanceFleetResizingSpecifications' => [ 'base' => 'The resize specification for On-Demand and Spot Instances in the fleet.
', 'refs' => [ 'InstanceFleet$ResizeSpecifications' => 'The resize specification for the instance fleet.
', 'InstanceFleetConfig$ResizeSpecifications' => 'The resize specification for the instance fleet.
', 'InstanceFleetModifyConfig$ResizeSpecifications' => 'The resize specification for the instance fleet.
', ], ], 'InstanceFleetState' => [ 'base' => NULL, 'refs' => [ 'InstanceFleetStatus$State' => 'A code representing the instance fleet status.
PROVISIONING—The instance fleet is provisioning Amazon EC2 resources and is not yet ready to run jobs.
BOOTSTRAPPING—Amazon EC2 instances and other resources have been provisioned and the bootstrap actions specified for the instances are underway.
RUNNING—Amazon EC2 instances and other resources are running. They are either executing jobs or waiting to execute jobs.
RESIZING—A resize operation is underway. Amazon EC2 instances are either being added or removed.
SUSPENDED—A resize operation could not complete. Existing Amazon EC2 instances are running, but instances can\'t be added or removed.
TERMINATING—The instance fleet is terminating Amazon EC2 instances.
TERMINATED—The instance fleet is no longer active, and all Amazon EC2 instances have been terminated.
Provides status change reason details for the instance fleet.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
Provides status change reason details for the instance fleet.
', ], ], 'InstanceFleetStateChangeReasonCode' => [ 'base' => NULL, 'refs' => [ 'InstanceFleetStateChangeReason$Code' => 'A code corresponding to the reason the state change occurred.
', ], ], 'InstanceFleetStatus' => [ 'base' => 'The status of the instance fleet.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
The current status of the instance fleet.
', ], ], 'InstanceFleetTimeline' => [ 'base' => 'Provides historical timestamps for the instance fleet, including the time of creation, the time it became ready to run jobs, and the time of termination.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
Provides historical timestamps for the instance fleet, including the time of creation, the time it became ready to run jobs, and the time of termination.
', ], ], 'InstanceFleetType' => [ 'base' => NULL, 'refs' => [ 'InstanceFleet$InstanceFleetType' => 'The node type that the instance fleet hosts. Valid values are MASTER, CORE, or TASK.
', 'InstanceFleetConfig$InstanceFleetType' => 'The node type that the instance fleet hosts. Valid values are MASTER, CORE, and TASK.
', 'ListInstancesInput$InstanceFleetType' => 'The node type of the instance fleet. For example MASTER, CORE, or TASK.
', ], ], 'InstanceGroup' => [ 'base' => 'This entity represents an instance group, which is a group of instances that have common purpose. For example, CORE instance group is used for HDFS.
', 'refs' => [ 'InstanceGroupList$member' => NULL, ], ], 'InstanceGroupConfig' => [ 'base' => 'Configuration defining a new instance group.
', 'refs' => [ 'InstanceGroupConfigList$member' => NULL, ], ], 'InstanceGroupConfigList' => [ 'base' => NULL, 'refs' => [ 'AddInstanceGroupsInput$InstanceGroups' => 'Instance groups to add.
', 'JobFlowInstancesConfig$InstanceGroups' => 'Configuration for the instance groups in a cluster.
', ], ], 'InstanceGroupDetail' => [ 'base' => 'Detailed information about an instance group.
', 'refs' => [ 'InstanceGroupDetailList$member' => NULL, ], ], 'InstanceGroupDetailList' => [ 'base' => NULL, 'refs' => [ 'JobFlowInstancesDetail$InstanceGroups' => 'Details about the instance groups in a cluster.
', ], ], 'InstanceGroupId' => [ 'base' => NULL, 'refs' => [ 'InstanceGroup$Id' => 'The identifier of the instance group.
', 'ListInstancesInput$InstanceGroupId' => 'The identifier of the instance group for which to list the instances.
', 'PutAutoScalingPolicyInput$InstanceGroupId' => 'Specifies the ID of the instance group to which the automatic scaling policy is applied.
', 'PutAutoScalingPolicyOutput$InstanceGroupId' => 'Specifies the ID of the instance group to which the scaling policy is applied.
', 'RemoveAutoScalingPolicyInput$InstanceGroupId' => 'Specifies the ID of the instance group to which the scaling policy is applied.
', ], ], 'InstanceGroupIdsList' => [ 'base' => NULL, 'refs' => [ 'AddInstanceGroupsOutput$InstanceGroupIds' => 'Instance group IDs of the newly created instance groups.
', ], ], 'InstanceGroupList' => [ 'base' => NULL, 'refs' => [ 'ListInstanceGroupsOutput$InstanceGroups' => 'The list of instance groups for the cluster and given filters.
', ], ], 'InstanceGroupModifyConfig' => [ 'base' => 'Modify the size or configurations of an instance group.
', 'refs' => [ 'InstanceGroupModifyConfigList$member' => NULL, ], ], 'InstanceGroupModifyConfigList' => [ 'base' => NULL, 'refs' => [ 'ModifyInstanceGroupsInput$InstanceGroups' => 'Instance groups to change.
', ], ], 'InstanceGroupState' => [ 'base' => NULL, 'refs' => [ 'InstanceGroupDetail$State' => 'State of instance group. The following values are no longer supported: STARTING, TERMINATED, and FAILED.
', 'InstanceGroupStatus$State' => 'The current state of the instance group.
', ], ], 'InstanceGroupStateChangeReason' => [ 'base' => 'The status change reason details for the instance group.
', 'refs' => [ 'InstanceGroupStatus$StateChangeReason' => 'The status change reason details for the instance group.
', ], ], 'InstanceGroupStateChangeReasonCode' => [ 'base' => NULL, 'refs' => [ 'InstanceGroupStateChangeReason$Code' => 'The programmable code for the state change reason.
', ], ], 'InstanceGroupStatus' => [ 'base' => 'The details of the instance group status.
', 'refs' => [ 'InstanceGroup$Status' => 'The current status of the instance group.
', ], ], 'InstanceGroupTimeline' => [ 'base' => 'The timeline of the instance group lifecycle.
', 'refs' => [ 'InstanceGroupStatus$Timeline' => 'The timeline of the instance group status over time.
', ], ], 'InstanceGroupType' => [ 'base' => NULL, 'refs' => [ 'InstanceGroup$InstanceGroupType' => 'The type of the instance group. Valid values are MASTER, CORE or TASK.
', 'InstanceGroupTypeList$member' => NULL, ], ], 'InstanceGroupTypeList' => [ 'base' => NULL, 'refs' => [ 'ListInstancesInput$InstanceGroupTypes' => 'The type of instance group for which to list the instances.
', ], ], 'InstanceId' => [ 'base' => NULL, 'refs' => [ 'EC2InstanceIdsList$member' => NULL, 'EC2InstanceIdsToTerminateList$member' => NULL, 'Instance$Id' => 'The unique identifier for the instance in Amazon EMR.
', 'Instance$Ec2InstanceId' => 'The unique identifier of the instance in Amazon EC2.
', ], ], 'InstanceList' => [ 'base' => NULL, 'refs' => [ 'ListInstancesOutput$Instances' => 'The list of instances for the cluster and given filters.
', ], ], 'InstanceResizePolicy' => [ 'base' => 'Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.
', 'refs' => [ 'ShrinkPolicy$InstanceResizePolicy' => 'Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.
', ], ], 'InstanceRoleType' => [ 'base' => NULL, 'refs' => [ 'InstanceGroupConfig$InstanceRole' => 'The role of the instance group in the cluster.
', 'InstanceGroupDetail$InstanceRole' => 'Instance group role in the cluster
', 'PlacementGroupConfig$InstanceRole' => 'Role of the instance in the cluster.
Starting with Amazon EMR release 5.23.0, the only supported instance role is MASTER.
The current state of the instance.
', ], ], 'InstanceStateChangeReason' => [ 'base' => 'The details of the status change reason for the instance.
', 'refs' => [ 'InstanceStatus$StateChangeReason' => 'The details of the status change reason for the instance.
', ], ], 'InstanceStateChangeReasonCode' => [ 'base' => NULL, 'refs' => [ 'InstanceStateChangeReason$Code' => 'The programmable code for the state change reason.
', ], ], 'InstanceStateList' => [ 'base' => NULL, 'refs' => [ 'ListInstancesInput$InstanceStates' => 'A list of instance states that will filter the instances returned with this request.
', ], ], 'InstanceStatus' => [ 'base' => 'The instance status details.
', 'refs' => [ 'Instance$Status' => 'The current status of the instance.
', ], ], 'InstanceTimeline' => [ 'base' => 'The timeline of the instance lifecycle.
', 'refs' => [ 'InstanceStatus$Timeline' => 'The timeline of the instance status over time.
', ], ], 'InstanceType' => [ 'base' => NULL, 'refs' => [ 'Instance$InstanceType' => 'The Amazon EC2 instance type, for example m3.xlarge.
The Amazon EC2 instance type for all instances in the instance group.
', 'InstanceGroupConfig$InstanceType' => 'The Amazon EC2 instance type for all instances in the instance group.
', 'InstanceGroupDetail$InstanceType' => 'Amazon EC2 instance type.
', 'InstanceTypeConfig$InstanceType' => 'An Amazon EC2 instance type, such as m3.xlarge.
The Amazon EC2 instance type, for example m3.xlarge.
The Amazon EC2 instance type of the master node.
', 'JobFlowInstancesConfig$SlaveInstanceType' => 'The Amazon EC2 instance type of the core and task nodes.
', 'JobFlowInstancesDetail$MasterInstanceType' => 'The Amazon EC2 master node instance type.
', 'JobFlowInstancesDetail$SlaveInstanceType' => 'The Amazon EC2 core and task node instance type.
', ], ], 'InstanceTypeConfig' => [ 'base' => 'An instance type configuration for each instance type in an instance fleet, which determines the Amazon EC2 instances Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities. When you use an allocation strategy, you can include a maximum of 30 instance type configurations for a fleet. For more information about how to use an allocation strategy, see Configure Instance Fleets. Without an allocation strategy, you may specify a maximum of five instance type configurations for a fleet.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
The instance type configurations that define the Amazon EC2 instances in the instance fleet.
', ], ], 'InstanceTypeSpecification' => [ 'base' => 'The configuration specification for each instance type in an instance fleet.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
An array of specifications for the instance types that comprise an instance fleet.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'CloudWatchAlarmDefinition$EvaluationPeriods' => 'The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.
The period, in seconds, over which the statistic is applied. CloudWatch metrics for Amazon EMR are emitted every five minutes (300 seconds), so if you specify a CloudWatch metric, specify 300.
An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.
', 'Cluster$EbsRootVolumeSize' => '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.
', 'Cluster$StepConcurrencyLevel' => 'Specifies the number of steps that can be executed concurrently.
', 'ClusterSummary$NormalizedInstanceHours' => 'An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.
', 'ComputeLimits$MinimumCapacityUnits' => '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.
', 'ComputeLimits$MaximumCapacityUnits' => '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.
', 'ComputeLimits$MaximumOnDemandCapacityUnits' => '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.
', 'ComputeLimits$MaximumCoreCapacityUnits' => '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.
', 'EbsBlockDeviceConfig$VolumesPerInstance' => 'Number of EBS volumes with a specific volume configuration that are associated with every instance in the instance group
', 'InstanceGroup$RequestedInstanceCount' => 'The target number of instances for the instance group.
', 'InstanceGroup$RunningInstanceCount' => 'The number of instances currently running in this instance group.
', 'InstanceGroupConfig$InstanceCount' => 'Target number of instances for the instance group.
', 'InstanceGroupDetail$InstanceRequestCount' => 'Target number of instances to run in the instance group.
', 'InstanceGroupDetail$InstanceRunningCount' => 'Actual count of running instances.
', 'InstanceGroupModifyConfig$InstanceCount' => 'Target size for the instance group.
', 'InstanceResizePolicy$InstanceTerminationTimeout' => 'Decommissioning timeout override for the specific list of instances to be terminated.
', 'JobFlowInstancesConfig$InstanceCount' => 'The number of Amazon EC2 instances in the cluster.
', 'JobFlowInstancesDetail$InstanceCount' => 'The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and core and task node. If the value is greater than 1, one instance is the master node and all others are core and task nodes.
', 'JobFlowInstancesDetail$NormalizedInstanceHours' => 'An approximation of the cost of the cluster, represented in m1.small/hours. This value is increased one time for every hour that an m1.small instance runs. Larger instances are weighted more heavily, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being increased incrementally four times. This result is only an approximation and does not reflect the actual billing rate.
', 'ModifyClusterInput$StepConcurrencyLevel' => 'The number of steps that can be executed concurrently. You can specify a minimum of 1 step and a maximum of 256 steps. We recommend that you do not change this parameter while steps are running or the ActionOnFailure setting may not behave as expected. For more information see Step$ActionOnFailure.
The number of steps that can be executed concurrently.
', 'RunJobFlowInput$EbsRootVolumeSize' => '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.
', 'RunJobFlowInput$StepConcurrencyLevel' => 'Specifies the number of steps that can be executed concurrently. The default value is 1. The maximum value is 256.
The lower boundary of Amazon EC2 instances in an instance group below which scaling activities are not allowed to shrink. Scale-in activities will not terminate instances below this boundary.
', 'ScalingConstraints$MaxCapacity' => 'The upper boundary of Amazon EC2 instances in an instance group beyond which scaling activities are not allowed to grow. Scale-out activities will not add instances beyond this boundary.
', 'ShrinkPolicy$DecommissionTimeout' => 'The desired timeout for decommissioning an instance. Overrides the default YARN decommissioning timeout.
', 'SimpleScalingPolicyConfiguration$ScalingAdjustment' => 'The amount by which to scale in or scale out, based on the specified AdjustmentType. A positive value adds to the instance group\'s Amazon EC2 instance count while a negative number removes instances. If AdjustmentType is set to EXACT_CAPACITY, the number should only be a positive integer. If AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, the value should express the percentage as an integer. For example, -20 indicates a decrease in 20% increments of cluster capacity.
The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start. The default value is 0.
', 'SupportedInstanceType$StorageGB' => ' StorageGB represents the storage capacity of the SupportedInstanceType. This value is 0 for Amazon EBS-only instance types.
The number of vCPUs available for the SupportedInstanceType.
Number of disks for the SupportedInstanceType. This value is 0 for Amazon EBS-only instance types.
The number of I/O operations per second (IOPS) that the volume supports.
', 'VolumeSpecification$SizeInGB' => 'The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10.
', ], ], 'InternalServerError' => [ 'base' => 'Indicates that an error occurred while processing the request and that the request was not completed.
', 'refs' => [], ], 'InternalServerException' => [ 'base' => 'This exception occurs when there is an internal failure in the Amazon EMR service.
', 'refs' => [], ], 'InvalidRequestException' => [ 'base' => 'This exception occurs when there is something wrong with user input.
', 'refs' => [], ], 'JobFlowDetail' => [ 'base' => 'A description of a cluster (job flow).
', 'refs' => [ 'JobFlowDetailList$member' => NULL, ], ], 'JobFlowDetailList' => [ 'base' => NULL, 'refs' => [ 'DescribeJobFlowsOutput$JobFlows' => 'A list of job flows matching the parameters supplied.
', ], ], 'JobFlowExecutionState' => [ 'base' => 'The type of instance.
', 'refs' => [ 'JobFlowExecutionStateList$member' => NULL, 'JobFlowExecutionStatusDetail$State' => 'The state of the job flow.
', ], ], 'JobFlowExecutionStateList' => [ 'base' => NULL, 'refs' => [ 'DescribeJobFlowsInput$JobFlowStates' => 'Return only job flows whose state is contained in this list.
', ], ], 'JobFlowExecutionStatusDetail' => [ 'base' => 'Describes the status of the cluster (job flow).
', 'refs' => [ 'JobFlowDetail$ExecutionStatusDetail' => 'Describes the execution status of the job flow.
', ], ], 'JobFlowInstancesConfig' => [ 'base' => 'A description of the Amazon EC2 instance on which the cluster (job flow) runs. A valid JobFlowInstancesConfig must contain either InstanceGroups or InstanceFleets. They cannot be used together. You may also have MasterInstanceType, SlaveInstanceType, and InstanceCount (all three must be present), but we don\'t recommend this configuration.
', 'refs' => [ 'RunJobFlowInput$Instances' => 'A specification of the number and type of Amazon EC2 instances.
', ], ], 'JobFlowInstancesDetail' => [ 'base' => 'Specify the type of Amazon EC2 instances that the cluster (job flow) runs on.
', 'refs' => [ 'JobFlowDetail$Instances' => 'Describes the Amazon EC2 instances of the job flow.
', ], ], 'KerberosAttributes' => [ 'base' => 'Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.
', 'refs' => [ 'Cluster$KerberosAttributes' => 'Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.
', 'RunJobFlowInput$KerberosAttributes' => 'Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.
', ], ], 'KeyValue' => [ 'base' => 'A key-value pair.
', 'refs' => [ 'KeyValueList$member' => NULL, ], ], 'KeyValueList' => [ 'base' => NULL, 'refs' => [ 'HadoopJarStepConfig$Properties' => 'A list of Java properties that are set when the step runs. You can use these properties to pass key-value pairs to your main function.
', ], ], 'ListBootstrapActionsInput' => [ 'base' => 'This input determines which bootstrap actions to retrieve.
', 'refs' => [], ], 'ListBootstrapActionsOutput' => [ 'base' => 'This output contains the bootstrap actions detail.
', 'refs' => [], ], 'ListClustersInput' => [ 'base' => 'This input determines how the ListClusters action filters the list of clusters that it returns.
', 'refs' => [], ], 'ListClustersOutput' => [ 'base' => 'This contains a ClusterSummaryList with the cluster details; for example, the cluster IDs, names, and status.
', 'refs' => [], ], 'ListInstanceFleetsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListInstanceFleetsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListInstanceGroupsInput' => [ 'base' => 'This input determines which instance groups to retrieve.
', 'refs' => [], ], 'ListInstanceGroupsOutput' => [ 'base' => 'This input determines which instance groups to retrieve.
', 'refs' => [], ], 'ListInstancesInput' => [ 'base' => 'This input determines which instances to list.
', 'refs' => [], ], 'ListInstancesOutput' => [ 'base' => 'This output contains the list of instances.
', 'refs' => [], ], 'ListNotebookExecutionsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookExecutionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListReleaseLabelsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListReleaseLabelsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityConfigurationsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityConfigurationsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStepsInput' => [ 'base' => 'This input determines which steps to list.
', 'refs' => [], ], 'ListStepsOutput' => [ 'base' => 'This output contains the list of steps returned in reverse order. This means that the last step is the first element in the list.
', 'refs' => [], ], 'ListStudioSessionMappingsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStudioSessionMappingsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStudiosInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStudiosOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListSupportedInstanceTypesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSupportedInstanceTypesOutput' => [ 'base' => NULL, 'refs' => [], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'AutoTerminationPolicy$IdleTimeout' => '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).
', 'InstanceGroup$ConfigurationsVersion' => 'The version number of the requested configuration specification for this instance group.
', 'InstanceGroup$LastSuccessfullyAppliedConfigurationsVersion' => 'The version number of a configuration specification that was successfully applied for an instance group last time.
', ], ], 'ManagedScalingPolicy' => [ 'base' => 'Managed scaling policy for an Amazon EMR cluster. The policy specifies the limits for resources that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
', 'refs' => [ 'GetManagedScalingPolicyOutput$ManagedScalingPolicy' => 'Specifies the managed scaling policy that is attached to an Amazon EMR cluster.
', 'PutManagedScalingPolicyInput$ManagedScalingPolicy' => 'Specifies the constraints for the managed scaling policy.
', 'RunJobFlowInput$ManagedScalingPolicy' => 'The specified managed scaling policy for an Amazon EMR cluster.
', ], ], 'Marker' => [ 'base' => NULL, 'refs' => [ 'ListBootstrapActionsInput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListBootstrapActionsOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListClustersInput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListClustersOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListInstanceFleetsInput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListInstanceFleetsOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListInstanceGroupsInput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListInstanceGroupsOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListInstancesInput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListInstancesOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListNotebookExecutionsInput$Marker' => 'The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.
A pagination token that a subsequent ListNotebookExecutions can use to determine the next set of results to retrieve.
The pagination token that indicates the set of results to retrieve.
', 'ListSecurityConfigurationsOutput$Marker' => 'A pagination token that indicates the next set of results to retrieve. Include the marker in the next ListSecurityConfiguration call to retrieve the next page of results, if required.
', 'ListStepsInput$Marker' => 'The maximum number of steps that a single ListSteps action returns is 50. To return a longer list of steps, use multiple ListSteps actions along with the Marker parameter, which is a pagination token that indicates the next set of results to retrieve.
The maximum number of steps that a single ListSteps action returns is 50. To return a longer list of steps, use multiple ListSteps actions along with the Marker parameter, which is a pagination token that indicates the next set of results to retrieve.
The pagination token that indicates the set of results to retrieve.
', 'ListStudioSessionMappingsOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListStudiosInput$Marker' => 'The pagination token that indicates the set of results to retrieve.
', 'ListStudiosOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', ], ], 'MarketType' => [ 'base' => NULL, 'refs' => [ 'Instance$Market' => 'The instance purchasing option. Valid values are ON_DEMAND or SPOT.
The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
', 'InstanceGroupConfig$Market' => 'Market type of the Amazon EC2 instances used to create a cluster node.
', 'InstanceGroupDetail$Market' => 'Market type of the Amazon EC2 instances used to create a cluster node.
', 'ScalingAction$Market' => 'Not available for instance groups. Instance groups use the market type specified for the group.
', ], ], 'MaxResultsNumber' => [ 'base' => NULL, 'refs' => [ 'DescribeReleaseLabelInput$MaxResults' => 'Reserved for future use. Currently set to null.
', 'ListReleaseLabelsInput$MaxResults' => 'Defines the maximum number of release labels to return in a single response. The default is 100.
A CloudWatch dimension, which is specified using a Key (known as a Name in CloudWatch), Value pair. By default, Amazon EMR uses one dimension whose Key is JobFlowID and Value is a variable representing the cluster ID, which is ${emr.clusterId}. This enables the rule to bootstrap when the cluster ID becomes available.
A CloudWatch metric dimension.
', ], ], 'ModifyClusterInput' => [ 'base' => NULL, 'refs' => [], ], 'ModifyClusterOutput' => [ 'base' => NULL, 'refs' => [], ], 'ModifyInstanceFleetInput' => [ 'base' => NULL, 'refs' => [], ], 'ModifyInstanceGroupsInput' => [ 'base' => 'Change the size of some instance groups.
', 'refs' => [], ], 'NewSupportedProductsList' => [ 'base' => NULL, 'refs' => [ 'RunJobFlowInput$NewSupportedProducts' => '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.
The value against which the specified statistic is compared.
', 'InstanceTypeConfig$BidPriceAsPercentageOfOnDemandPrice' => 'The bid price, as a percentage of On-Demand price, for each Amazon EC2 Spot Instance as defined by InstanceType. Expressed as a number (for example, 20 specifies 20%). If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
The bid price, as a percentage of On-Demand price, for each Amazon EC2 Spot Instance as defined by InstanceType. Expressed as a number (for example, 20 specifies 20%).
A notebook execution. An execution is a specific instance that an Amazon EMR Notebook is run using the StartNotebookExecution action.
Properties of the notebook execution.
', ], ], 'NotebookExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'ListNotebookExecutionsInput$Status' => 'The status filter for listing notebook executions.
START_PENDING indicates that the cluster has received the execution request but execution has not begun.
STARTING indicates that the execution is starting on the cluster.
RUNNING indicates that the execution is being processed by the cluster.
FINISHING indicates that execution processing is in the final stages.
FINISHED indicates that the execution has completed without error.
FAILING indicates that the execution is failing and will not finish successfully.
FAILED indicates that the execution failed.
STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and the stop is pending.
STOPPING indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution request.
STOPPED indicates that the execution stopped because of a StopNotebookExecution request.
The status of the notebook execution.
START_PENDING indicates that the cluster has received the execution request but execution has not begun.
STARTING indicates that the execution is starting on the cluster.
RUNNING indicates that the execution is being processed by the cluster.
FINISHING indicates that execution processing is in the final stages.
FINISHED indicates that the execution has completed without error.
FAILING indicates that the execution is failing and will not finish successfully.
FAILED indicates that the execution failed.
STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and the stop is pending.
STOPPING indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution request.
STOPPED indicates that the execution stopped because of a StopNotebookExecution request.
The status of the notebook execution.
START_PENDING indicates that the cluster has received the execution request but execution has not begun.
STARTING indicates that the execution is starting on the cluster.
RUNNING indicates that the execution is being processed by the cluster.
FINISHING indicates that execution processing is in the final stages.
FINISHED indicates that the execution has completed without error.
FAILING indicates that the execution is failing and will not finish successfully.
FAILED indicates that the execution failed.
STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and the stop is pending.
STOPPING indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution request.
STOPPED indicates that the execution stopped because of a StopNotebookExecution request.
Details for a notebook execution. The details include information such as the unique ID and status of the notebook execution.
', 'refs' => [ 'NotebookExecutionSummaryList$member' => NULL, ], ], 'NotebookExecutionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListNotebookExecutionsOutput$NotebookExecutions' => 'A list of notebook executions.
', ], ], 'NotebookS3LocationForOutput' => [ 'base' => 'The Amazon S3 location that stores the notebook execution input.
', 'refs' => [ 'NotebookExecution$NotebookS3Location' => 'The Amazon S3 location that stores the notebook execution input.
', 'NotebookExecutionSummary$NotebookS3Location' => 'The Amazon S3 location that stores the notebook execution input.
', ], ], 'NotebookS3LocationFromInput' => [ 'base' => 'The Amazon S3 location that stores the notebook execution input.
', 'refs' => [ 'StartNotebookExecutionInput$NotebookS3Location' => 'The Amazon S3 location for the notebook execution input.
', ], ], 'OSRelease' => [ 'base' => 'The Amazon Linux release specified for a cluster in the RunJobFlow request.
', 'refs' => [ 'OSReleaseList$member' => NULL, ], ], 'OSReleaseList' => [ 'base' => NULL, 'refs' => [ 'DescribeReleaseLabelOutput$AvailableOSReleases' => 'The list of available Amazon Linux release versions for an Amazon EMR release. Contains a Label field that is formatted as shown in Amazon Linux 2 Release Notes . For example, 2.0.20220218.1.
', ], ], 'OnDemandCapacityReservationOptions' => [ 'base' => 'Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
', 'refs' => [ 'OnDemandProvisioningSpecification$CapacityReservationOptions' => 'The launch specification for On-Demand instances in the instance fleet, which determines the allocation strategy.
', ], ], 'OnDemandCapacityReservationPreference' => [ 'base' => NULL, 'refs' => [ 'OnDemandCapacityReservationOptions$CapacityReservationPreference' => 'Indicates the instance\'s Capacity Reservation preferences. Possible preferences include:
open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.
Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price).
If you do not specify a value, the fleet fulfills the On-Demand capacity according to the chosen On-Demand allocation strategy.
', ], ], 'OnDemandProvisioningAllocationStrategy' => [ 'base' => NULL, 'refs' => [ 'OnDemandProvisioningSpecification$AllocationStrategy' => 'Specifies the strategy to use in launching On-Demand instance fleets. Currently, the only option is lowest-price (the default), which launches the lowest price first.
The launch specification for On-Demand Instances in the instance fleet, which determines the allocation strategy.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is available in Amazon EMR releases 5.12.1 and later.
The launch specification for On-Demand Instances in the instance fleet, which determines the allocation strategy.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is available in Amazon EMR releases 5.12.1 and later.
The resize specification for On-Demand Instances in the instance fleet, which contains the resize timeout period.
', 'refs' => [ 'InstanceFleetResizingSpecifications$OnDemandResizeSpecification' => 'The resize specification for On-Demand Instances in the instance fleet, which contains the resize timeout period.
', ], ], 'OptionalArnType' => [ 'base' => NULL, 'refs' => [ 'Cluster$OutpostArn' => 'The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.
', 'ClusterSummary$OutpostArn' => 'The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.
', 'Step$ExecutionRoleArn' => 'The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format: arn:partition:service:region:account:resource.
For example, arn:aws:IAM::1234567890:role/ReadOnly is a correctly formatted runtime role ARN.
The output format for the notebook execution.
', 'StartNotebookExecutionInput$OutputNotebookFormat' => 'The output format for the notebook execution.
', ], ], 'OutputNotebookS3LocationForOutput' => [ 'base' => 'The Amazon S3 location that stores the notebook execution output.
', 'refs' => [ 'NotebookExecution$OutputNotebookS3Location' => 'The Amazon S3 location for the notebook execution output.
', ], ], 'OutputNotebookS3LocationFromInput' => [ 'base' => 'The Amazon S3 location that stores the notebook execution output.
', 'refs' => [ 'StartNotebookExecutionInput$OutputNotebookS3Location' => 'The Amazon S3 location for the notebook execution output.
', ], ], 'PlacementGroupConfig' => [ 'base' => 'Placement group configuration for an Amazon EMR cluster. The configuration specifies the placement strategy that can be applied to instance roles during cluster creation.
To use this configuration, consider attaching managed policy AmazonElasticMapReducePlacementGroupPolicy to the Amazon EMR role.
', 'refs' => [ 'PlacementGroupConfigList$member' => NULL, ], ], 'PlacementGroupConfigList' => [ 'base' => NULL, 'refs' => [ 'Cluster$PlacementGroups' => 'Placement group configured for an Amazon EMR cluster.
', 'RunJobFlowInput$PlacementGroupConfigs' => 'The specified placement group configuration for an Amazon EMR cluster.
', ], ], 'PlacementGroupStrategy' => [ 'base' => NULL, 'refs' => [ 'PlacementGroupConfig$PlacementStrategy' => 'Amazon EC2 Placement Group strategy associated with instance role.
Starting with Amazon EMR release 5.23.0, the only supported placement strategy is SPREAD for the MASTER instance role.
The Amazon EC2 Availability Zone configuration of the cluster (job flow).
', 'refs' => [ 'JobFlowInstancesConfig$Placement' => 'The Availability Zone in which the cluster runs.
', 'JobFlowInstancesDetail$Placement' => 'The Amazon EC2 Availability Zone for the cluster.
', ], ], 'Port' => [ 'base' => NULL, 'refs' => [ 'PortRange$MinRange' => 'The smallest port number in a specified range of port numbers.
', 'PortRange$MaxRange' => 'The smallest port number in a specified range of port numbers.
', ], ], 'PortRange' => [ 'base' => 'A list of port ranges that are permitted to allow inbound traffic from all public IP addresses. To specify a single port, use the same value for MinRange and MaxRange.
Specifies ports and port ranges that are permitted to have security group rules that allow inbound traffic from all public sources. For example, if Port 23 (Telnet) is specified for PermittedPublicSecurityGroupRuleRanges, Amazon EMR allows cluster creation if a security group associated with the cluster has a rule that allows inbound traffic on Port 23 from IPv4 0.0.0.0/0 or IPv6 port ::/0 as the source.
By default, Port 22, which is used for SSH access to the cluster Amazon EC2 instances, is in the list of PermittedPublicSecurityGroupRuleRanges.
Type of reconfiguration requested. Valid values are MERGE and OVERWRITE.
', ], ], 'ReleaseLabelFilter' => [ 'base' => 'The release label filters by application or version prefix.
', 'refs' => [ 'ListReleaseLabelsInput$Filters' => 'Filters the results of the request. Prefix specifies the prefix of release labels to return. Application specifies the application (with/without version) of release labels to return.
This input identifies an Amazon EMR resource and a list of tags to remove.
', 'refs' => [], ], 'RemoveTagsOutput' => [ 'base' => 'This output indicates the result of removing tags from the resource.
', 'refs' => [], ], 'RepoUpgradeOnBoot' => [ 'base' => NULL, 'refs' => [ 'Cluster$RepoUpgradeOnBoot' => 'Applies only when CustomAmiID is used. Specifies the type of updates that the Amazon Linux AMI package repositories apply when an instance boots using the AMI.
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.
The Amazon EMR resource identifier to which tags will be added. For example, a cluster identifier or an Amazon EMR Studio ID.
', 'RemoveTagsInput$ResourceId' => 'The Amazon EMR resource identifier from which tags will be removed. For example, a cluster identifier or an Amazon EMR Studio ID.
', ], ], 'RunJobFlowInput' => [ 'base' => 'Input to the RunJobFlow operation.
', 'refs' => [], ], 'RunJobFlowOutput' => [ 'base' => 'The result of the RunJobFlow operation.
', 'refs' => [], ], 'ScaleDownBehavior' => [ 'base' => NULL, 'refs' => [ 'Cluster$ScaleDownBehavior' => '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 is available only in Amazon EMR releases 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.
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.
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.
The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.
', 'refs' => [ 'ScalingRule$Action' => 'The conditions that trigger an automatic scaling activity.
', ], ], 'ScalingConstraints' => [ 'base' => 'The upper and lower Amazon EC2 instance limits for an automatic scaling policy. Automatic scaling activities triggered by automatic scaling rules will not cause an instance group to grow above or below these limits.
', 'refs' => [ 'AutoScalingPolicy$Constraints' => 'The upper and lower Amazon EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits.
', 'AutoScalingPolicyDescription$Constraints' => 'The upper and lower Amazon EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits.
', ], ], 'ScalingRule' => [ 'base' => 'A scale-in or scale-out rule that defines scaling activity, including the CloudWatch metric alarm that triggers activity, how Amazon EC2 instances are added or removed, and the periodicity of adjustments. The automatic scaling policy for an instance group can comprise one or more automatic scaling rules.
', 'refs' => [ 'ScalingRuleList$member' => NULL, ], ], 'ScalingRuleList' => [ 'base' => NULL, 'refs' => [ 'AutoScalingPolicy$Rules' => 'The scale-in and scale-out rules that comprise the automatic scaling policy.
', 'AutoScalingPolicyDescription$Rules' => 'The scale-in and scale-out rules that comprise the automatic scaling policy.
', ], ], 'ScalingTrigger' => [ 'base' => 'The conditions that trigger an automatic scaling activity.
', 'refs' => [ 'ScalingRule$Trigger' => 'The CloudWatch alarm definition that determines when automatic scaling activity is triggered.
', ], ], 'ScriptBootstrapActionConfig' => [ 'base' => 'Configuration of the script to run during a bootstrap action.
', 'refs' => [ 'BootstrapActionConfig$ScriptBootstrapAction' => 'The script run by the bootstrap action.
', ], ], 'SecurityConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ListSecurityConfigurationsOutput$SecurityConfigurations' => 'The creation date and time, and name, of each security configuration.
', ], ], 'SecurityConfigurationSummary' => [ 'base' => 'The creation date and time, and name, of a security configuration.
', 'refs' => [ 'SecurityConfigurationList$member' => NULL, ], ], 'SecurityGroupsList' => [ 'base' => NULL, 'refs' => [ 'JobFlowInstancesConfig$AdditionalMasterSecurityGroups' => 'A list of additional Amazon EC2 security group IDs for the master node.
', 'JobFlowInstancesConfig$AdditionalSlaveSecurityGroups' => 'A list of additional Amazon EC2 security group IDs for the core and task nodes.
', ], ], 'SessionMappingDetail' => [ 'base' => 'Details for an Amazon EMR Studio session mapping including creation time, user or group ID, Studio ID, and so on.
', 'refs' => [ 'GetStudioSessionMappingOutput$SessionMapping' => 'The session mapping details for the specified Amazon EMR Studio and identity, including session policy ARN and creation time.
', ], ], 'SessionMappingSummary' => [ 'base' => 'Details for an Amazon EMR Studio session mapping. The details do not include the time the session mapping was last modified.
', 'refs' => [ 'SessionMappingSummaryList$member' => NULL, ], ], 'SessionMappingSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListStudioSessionMappingsOutput$SessionMappings' => 'A list of session mapping summary objects. Each object includes session mapping details such as creation time, identity type (user or group), and Amazon EMR Studio ID.
', ], ], 'SetTerminationProtectionInput' => [ 'base' => 'The input argument to the TerminationProtection operation.
', 'refs' => [], ], 'SetVisibleToAllUsersInput' => [ 'base' => 'The input to the SetVisibleToAllUsers action.
', 'refs' => [], ], 'ShrinkPolicy' => [ 'base' => 'Policy for customizing shrink operations. Allows configuration of decommissioning timeout and targeted instance shrinking.
', 'refs' => [ 'InstanceGroup$ShrinkPolicy' => 'Policy for customizing shrink operations.
', 'InstanceGroupModifyConfig$ShrinkPolicy' => 'Policy for customizing shrink operations.
', ], ], 'SimpleScalingPolicyConfiguration' => [ 'base' => 'An automatic scaling configuration, which describes how the policy adds or removes instances, the cooldown period, and the number of Amazon EC2 instances that will be added each time the CloudWatch metric alarm condition is satisfied.
', 'refs' => [ 'ScalingAction$SimpleScalingPolicyConfiguration' => 'The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.
', ], ], 'SimplifiedApplication' => [ 'base' => 'The returned release label application names or versions.
', 'refs' => [ 'SimplifiedApplicationList$member' => NULL, ], ], 'SimplifiedApplicationList' => [ 'base' => NULL, 'refs' => [ 'DescribeReleaseLabelOutput$Applications' => 'The list of applications available for the target release label. Name is the name of the application. Version is the concise version of the application.
Specifies the strategy to use in launching Spot Instance fleets. Currently, the only option is capacity-optimized (the default), which launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.
', ], ], 'SpotProvisioningSpecification' => [ 'base' => 'The launch specification for Spot Instances in the instance fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. Spot Instance allocation strategy is available in Amazon EMR releases 5.12.1 and later.
Spot Instances with a defined duration (also known as Spot blocks) are no longer available to new customers from July 1, 2021. For customers who have previously used the feature, we will continue to support Spot Instances with a defined duration until December 31, 2022.
The launch specification for Spot instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.
', ], ], 'SpotProvisioningTimeoutAction' => [ 'base' => NULL, 'refs' => [ 'SpotProvisioningSpecification$TimeoutAction' => 'The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot Instances could not be provisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot Instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.
The resize specification for Spot Instances in the instance fleet, which contains the resize timeout period.
', 'refs' => [ 'InstanceFleetResizingSpecifications$SpotResizeSpecification' => 'The resize specification for Spot Instances in the instance fleet, which contains the resize timeout period.
', ], ], 'StartNotebookExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'StartNotebookExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'Statistic' => [ 'base' => NULL, 'refs' => [ 'CloudWatchAlarmDefinition$Statistic' => 'The statistic to apply to the metric associated with the alarm. The default is AVERAGE.
This represents a step in a cluster.
', 'refs' => [ 'DescribeStepOutput$Step' => 'The step details for the requested step identifier.
', ], ], 'StepCancellationOption' => [ 'base' => NULL, 'refs' => [ 'CancelStepsInput$StepCancellationOption' => 'The option to choose to cancel RUNNING steps. By default, the value is SEND_INTERRUPT.
Specification for a cluster (job flow) step.
', 'refs' => [ 'StepConfigList$member' => NULL, 'StepDetail$StepConfig' => 'The step configuration.
', ], ], 'StepConfigList' => [ 'base' => NULL, 'refs' => [ 'AddJobFlowStepsInput$Steps' => 'A list of StepConfig to be executed by the job flow.
', 'RunJobFlowInput$Steps' => 'A list of steps to run.
', ], ], 'StepDetail' => [ 'base' => 'Combines the execution state and configuration of a step.
', 'refs' => [ 'StepDetailList$member' => NULL, ], ], 'StepDetailList' => [ 'base' => NULL, 'refs' => [ 'JobFlowDetail$Steps' => 'A list of steps run by the job flow.
', ], ], 'StepExecutionState' => [ 'base' => NULL, 'refs' => [ 'StepExecutionStatusDetail$State' => 'The state of the step.
', ], ], 'StepExecutionStatusDetail' => [ 'base' => 'The execution state of a step.
', 'refs' => [ 'StepDetail$ExecutionStatusDetail' => 'The description of the step status.
', ], ], 'StepId' => [ 'base' => NULL, 'refs' => [ 'CancelStepsInfo$StepId' => 'The encrypted StepId of a step.
', 'DescribeStepInput$StepId' => 'The identifier of the step to describe.
', 'Step$Id' => 'The identifier of the cluster step.
', 'StepSummary$Id' => 'The identifier of the cluster step.
', ], ], 'StepIdsList' => [ 'base' => NULL, 'refs' => [ 'AddJobFlowStepsOutput$StepIds' => 'The identifiers of the list of steps added to the job flow.
', 'CancelStepsInput$StepIds' => 'The list of StepIDs to cancel. Use ListSteps to get steps and their states for the specified cluster.
The execution state of the cluster step.
', ], ], 'StepStateChangeReason' => [ 'base' => 'The details of the step state change reason.
', 'refs' => [ 'StepStatus$StateChangeReason' => 'The reason for the step execution status change.
', ], ], 'StepStateChangeReasonCode' => [ 'base' => NULL, 'refs' => [ 'StepStateChangeReason$Code' => 'The programmable code for the state change reason. Note: Currently, the service provides no code for the state change.
', ], ], 'StepStateList' => [ 'base' => NULL, 'refs' => [ 'ListStepsInput$StepStates' => 'The filter to limit the step list based on certain states.
', ], ], 'StepStatus' => [ 'base' => 'The execution status details of the cluster step.
', 'refs' => [ 'Step$Status' => 'The current execution status details of the cluster step.
', 'StepSummary$Status' => 'The current execution status details of the cluster step.
', ], ], 'StepSummary' => [ 'base' => 'The summary of the cluster step.
', 'refs' => [ 'StepSummaryList$member' => NULL, ], ], 'StepSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListStepsOutput$Steps' => 'The filtered list of steps for the cluster.
', ], ], 'StepTimeline' => [ 'base' => 'The timeline of the cluster step lifecycle.
', 'refs' => [ 'StepStatus$Timeline' => 'The timeline of the cluster step status over time.
', ], ], 'StopNotebookExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'Application$Name' => 'The name of the application.
', 'Application$Version' => 'The version of the application.
', 'AutoScalingPolicyStateChangeReason$Message' => 'A friendly, more verbose message that accompanies an automatic scaling policy state change.
', 'CancelStepsInfo$Reason' => 'The reason for the failure if the CancelSteps request fails.
', 'CloudWatchAlarmDefinition$MetricName' => 'The name of the CloudWatch metric that is watched to determine an alarm condition.
', 'CloudWatchAlarmDefinition$Namespace' => 'The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.
The name of the cluster.
', 'Cluster$LogUri' => 'The path to the Amazon S3 location where logs for this cluster are stored.
', 'Cluster$LogEncryptionKmsKeyId' => 'The KMS key used for encrypting log files. This attribute is only available with Amazon EMR 5.30.0 and later, excluding Amazon EMR 6.0.0.
', 'Cluster$RequestedAmiVersion' => 'The AMI version requested for this cluster.
', 'Cluster$RunningAmiVersion' => 'The AMI version running on this cluster.
', 'Cluster$ReleaseLabel' => '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.
The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.
', 'Cluster$MasterPublicDnsName' => 'The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.
', 'Cluster$OSReleaseLabel' => 'The Amazon Linux release specified in a cluster launch RunJobFlow request. If no Amazon Linux release was specified, the default Amazon Linux release is shown in the response.
', 'ClusterStateChangeReason$Message' => 'The descriptive message for the state change reason.
', 'ClusterSummary$Name' => 'The name of the cluster.
', 'Command$Name' => 'The name of the command.
', 'Command$ScriptPath' => 'The Amazon S3 location of the command script.
', 'Configuration$Classification' => 'The classification within a configuration.
', 'CreateSecurityConfigurationInput$SecurityConfiguration' => 'The security configuration details in JSON format. For JSON parameters and examples, see Use Security Configurations to Set Up Cluster Security in the Amazon EMR Management Guide.
', 'DescribeReleaseLabelInput$ReleaseLabel' => 'The target release label to be described.
', 'DescribeReleaseLabelInput$NextToken' => 'The pagination token. Reserved for future use. Currently set to null.
', 'DescribeReleaseLabelOutput$ReleaseLabel' => 'The target release label described in the response.
', 'DescribeReleaseLabelOutput$NextToken' => 'The pagination token. Reserved for future use. Currently set to null.
', 'DescribeSecurityConfigurationOutput$SecurityConfiguration' => 'The security configuration details in JSON format.
', 'EbsBlockDevice$Device' => 'The device name that is exposed to the instance, such as /dev/sdh.
', 'EbsVolume$Device' => 'The device name that is exposed to the instance, such as /dev/sdh.
', 'EbsVolume$VolumeId' => 'The volume identifier of the EBS volume.
', 'Ec2InstanceAttributes$Ec2KeyName' => 'The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named "hadoop".
', 'Ec2InstanceAttributes$Ec2SubnetId' => '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.
', 'Ec2InstanceAttributes$Ec2AvailabilityZone' => 'The Availability Zone in which the cluster will run.
', 'Ec2InstanceAttributes$IamInstanceProfile' => 'The IAM role that was specified when the cluster was launched. The Amazon EC2 instances of the cluster assume this role.
', 'Ec2InstanceAttributes$EmrManagedMasterSecurityGroup' => 'The identifier of the Amazon EC2 security group for the master node.
', 'Ec2InstanceAttributes$EmrManagedSlaveSecurityGroup' => 'The identifier of the Amazon EC2 security group for the core and task nodes.
', 'Ec2InstanceAttributes$ServiceAccessSecurityGroup' => 'The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
', 'ErrorDetail$ErrorCode' => 'The name or code associated with the error.
', 'ErrorDetail$ErrorMessage' => 'A message that describes the error.
', 'FailureDetails$Reason' => 'The reason for the step failure. In the case where the service cannot successfully determine the root cause of the failure, it returns "Unknown Error" as a reason.
', 'FailureDetails$Message' => 'The descriptive message including the error the Amazon EMR service has identified as the cause of step failure. This is text from an error log that describes the root cause of the failure.
', 'FailureDetails$LogFile' => 'The path to the log file where the step failure root cause was originally recorded.
', 'HadoopStepConfig$Jar' => 'The path to the JAR file that runs during the step.
', 'HadoopStepConfig$MainClass' => 'The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file.
', 'Instance$PublicDnsName' => 'The public DNS name of the instance.
', 'Instance$PublicIpAddress' => 'The public IP address of the instance.
', 'Instance$PrivateDnsName' => 'The private DNS name of the instance.
', 'Instance$PrivateIpAddress' => 'The private IP address of the instance.
', 'Instance$InstanceGroupId' => 'The identifier of the instance group to which this instance belongs.
', 'InstanceFleetStateChangeReason$Message' => 'An explanatory message.
', 'InstanceGroup$Name' => 'The name of the instance group.
', 'InstanceGroup$BidPrice' => 'If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice to set the amount equal to the On-Demand price, or specify an amount in USD.
The status change reason description.
', 'InstanceStateChangeReason$Message' => 'The status change reason description.
', 'ListReleaseLabelsInput$NextToken' => 'Specifies the next page of results. If NextToken is not specified, which is usually the case for the first request of ListReleaseLabels, the first page of results are determined by other filtering parameters or by the latest version. The ListReleaseLabels request fails if the identity (Amazon Web Services account ID) and all filtering parameters are different from the original request, or if the NextToken is expired or tampered with.
Used to paginate the next page of results if specified in the next ListReleaseLabels request.
The Amazon EMR release label determines the versions of open-source application packages that Amazon EMR has installed on the cluster. Release labels are in the format emr-x.x.x, where x.x.x is an Amazon EMR release number such as emr-6.10.0. For more information about Amazon EMR releases and their included application versions and features, see the Amazon EMR Release Guide .
The pagination token that marks the next set of results to retrieve.
', 'ListSupportedInstanceTypesOutput$Marker' => 'The pagination token that marks the next set of results to retrieve.
', 'MetricDimension$Key' => 'The dimension name.
', 'MetricDimension$Value' => 'The dimension value.
', 'ModifyClusterInput$ClusterId' => 'The unique identifier of the cluster.
', 'OSRelease$Label' => 'The Amazon Linux release specified for a cluster in the RunJobFlow request. The format is as shown in Amazon Linux 2 Release Notes . For example, 2.0.20220218.1.
', 'ReleaseLabelFilter$Prefix' => 'Optional release label version prefix filter. For example, emr-5.
Optional release label application filter. For example, spark@2.1.0.
The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy.
', 'ScalingRule$Description' => 'A friendly, more verbose description of the automatic scaling rule.
', 'SimplifiedApplication$Name' => 'The returned release label application name. For example, hadoop.
The returned release label application version. For example, 3.2.1.
The name of the cluster step.
', 'StepStateChangeReason$Message' => 'The descriptive message for the state change reason.
', 'StepSummary$Name' => 'The name of the cluster step.
', 'StringList$member' => NULL, 'StringMap$key' => NULL, 'StringMap$value' => NULL, 'SubnetIdList$member' => NULL, 'SupportedInstanceType$Type' => 'The Amazon EC2 instance type, for example m5.xlarge, of the SupportedInstanceType.
The Amazon EC2 family and generation for the SupportedInstanceType.
The CPU architecture, for example X86_64 or AARCH64.
A user-defined key, which is the minimum required information for a valid tag. For more information, see Tag.
', 'Tag$Value' => 'A user-defined value, which is optional in a tag. For more information, see Tag Clusters.
', 'VolumeSpecification$VolumeType' => 'The volume type. Volume types supported are gp3, gp2, io1, st1, sc1, and standard.
', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'Application$Args' => 'Arguments for Amazon EMR to pass to the application.
', 'Command$Args' => 'Arguments for Amazon EMR to pass to the command for execution.
', 'Ec2InstanceAttributes$AdditionalMasterSecurityGroups' => 'A list of additional Amazon EC2 security group IDs for the master node.
', 'Ec2InstanceAttributes$AdditionalSlaveSecurityGroups' => 'A list of additional Amazon EC2 security group IDs for the core and task nodes.
', 'HadoopStepConfig$Args' => 'The list of command line arguments to pass to the JAR file\'s main function for execution.
', 'ListReleaseLabelsOutput$ReleaseLabels' => 'The returned release labels.
', 'RemoveTagsInput$TagKeys' => 'A list of tag keys to remove from the resource.
', ], ], 'StringMap' => [ 'base' => NULL, 'refs' => [ 'Application$AdditionalInfo' => 'This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.
', 'Configuration$Properties' => 'A set of properties specified within a configuration classification.
', 'ErrorData$member' => NULL, 'HadoopStepConfig$Properties' => 'The list of Java properties that are set when the step runs. You can use these properties to pass key-value pairs to your main function.
', ], ], 'Studio' => [ 'base' => 'Details for an Amazon EMR Studio including ID, creation time, name, and so on.
', 'refs' => [ 'DescribeStudioOutput$Studio' => 'The Amazon EMR Studio details.
', ], ], 'StudioSummary' => [ 'base' => 'Details for an Amazon EMR Studio, including ID, Name, VPC, and Description. The details do not include subnets, IAM roles, security groups, or tags associated with the Studio.
', 'refs' => [ 'StudioSummaryList$member' => NULL, ], ], 'StudioSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListStudiosOutput$Studios' => 'The list of Studio summary objects.
', ], ], 'SubnetIdList' => [ 'base' => NULL, 'refs' => [ 'CreateStudioInput$SubnetIds' => 'A list of subnet IDs to associate with the Amazon EMR Studio. A Studio can have a maximum of 5 subnets. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets.
The list of IDs of the subnets associated with the Amazon EMR Studio.
', 'UpdateStudioInput$SubnetIds' => 'A list of subnet IDs to associate with the Amazon EMR Studio. The list can include new subnet IDs, but must also include all of the subnet IDs previously associated with the Studio. The list order does not matter. A Studio can have a maximum of 5 subnets. The subnets must belong to the same VPC as the Studio.
', ], ], 'SupportedInstanceType' => [ 'base' => 'An instance type that the specified Amazon EMR release supports.
', 'refs' => [ 'SupportedInstanceTypesList$member' => NULL, ], ], 'SupportedInstanceTypesList' => [ 'base' => NULL, 'refs' => [ 'ListSupportedInstanceTypesOutput$SupportedInstanceTypes' => 'The list of instance types that the release specified in ListSupportedInstanceTypesInput$ReleaseLabel supports, filtered by Amazon Web Services Region.
The list of supported product configurations that allow user-supplied arguments. Amazon EMR accepts these arguments and forwards them to the corresponding installation script as bootstrap action arguments.
', 'refs' => [ 'NewSupportedProductsList$member' => NULL, ], ], 'SupportedProductsList' => [ 'base' => NULL, 'refs' => [ 'JobFlowDetail$SupportedProducts' => 'A list of strings set by third-party software when the job flow is launched. If you are not using third-party software to manage the job flow, this value is empty.
', 'RunJobFlowInput$SupportedProducts' => '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.
A key-value pair containing user-defined metadata that you can associate with an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'AddTagsInput$Tags' => 'A list of tags to associate with a resource. 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.
', 'Cluster$Tags' => 'A list of tags associated with a cluster.
', 'CreateStudioInput$Tags' => 'A list of tags to associate with the Amazon EMR Studio. 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.
', 'NotebookExecution$Tags' => '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.
', 'RunJobFlowInput$Tags' => 'A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
', 'StartNotebookExecutionInput$Tags' => '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.
', 'Studio$Tags' => 'A list of tags associated with the Amazon EMR Studio.
', ], ], 'TerminateJobFlowsInput' => [ 'base' => 'Input to the TerminateJobFlows operation.
', 'refs' => [], ], 'ThroughputVal' => [ 'base' => NULL, 'refs' => [ 'VolumeSpecification$Throughput' => 'The throughput, in mebibyte per second (MiB/s). This optional parameter can be a number from 125 - 1000 and is valid only for gp3 volumes.
', ], ], 'Unit' => [ 'base' => NULL, 'refs' => [ 'CloudWatchAlarmDefinition$Unit' => 'The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.
The key to the Amazon S3 location that stores the notebook execution input.
', 'NotebookS3LocationFromInput$Key' => 'The key to the Amazon S3 location that stores the notebook execution input.
', 'OutputNotebookS3LocationForOutput$Key' => 'The key to the Amazon S3 location that stores the notebook execution output.
', 'OutputNotebookS3LocationFromInput$Key' => 'The key to the Amazon S3 location that stores the notebook execution output.
', ], ], 'UsernamePassword' => [ 'base' => 'The username and password that you use to connect to cluster endpoints.
', 'refs' => [ 'Credentials$UsernamePassword' => 'The username and password that you use to connect to cluster endpoints.
', ], ], 'VolumeSpecification' => [ 'base' => 'EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s) that are requested for the EBS volume attached to an Amazon EC2 instance in the cluster.
', 'refs' => [ 'EbsBlockDevice$VolumeSpecification' => 'EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s) that are requested for the EBS volume attached to an Amazon EC2 instance in the cluster.
', 'EbsBlockDeviceConfig$VolumeSpecification' => 'EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s) that are requested for the EBS volume attached to an Amazon EC2 instance in the cluster.
', ], ], 'WholeNumber' => [ 'base' => NULL, 'refs' => [ 'InstanceFleet$TargetOnDemandCapacity' => 'The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand Instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an On-Demand Instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedOnDemandCapacity to determine the Spot capacity units that have been provisioned for the instance fleet.
If not specified or set to 0, only Spot Instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.
The target capacity of Spot units for the instance fleet, which determines how many Spot Instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedSpotCapacity to determine the Spot capacity units that have been provisioned for the instance fleet.
If not specified or set to 0, only On-Demand Instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.
The number of On-Demand units that have been provisioned for the instance fleet to fulfill TargetOnDemandCapacity. This provisioned capacity might be less than or greater than TargetOnDemandCapacity.
The number of Spot units that have been provisioned for this instance fleet to fulfill TargetSpotCapacity. This provisioned capacity might be less than or greater than TargetSpotCapacity.
The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand Instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an On-Demand Instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.
If not specified or set to 0, only Spot Instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.
The target capacity of Spot units for the instance fleet, which determines how many Spot Instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot Instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.
If not specified or set to 0, only On-Demand Instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.
The target capacity of On-Demand units for the instance fleet. For more information see InstanceFleetConfig$TargetOnDemandCapacity.
', 'InstanceFleetModifyConfig$TargetSpotCapacity' => 'The target capacity of Spot units for the instance fleet. For more information, see InstanceFleetConfig$TargetSpotCapacity.
', 'InstanceTypeConfig$WeightedCapacity' => 'The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. This value is 1 for a master instance fleet, and must be 1 or greater for core and task instance fleets. Defaults to 1 if not specified.
', 'InstanceTypeSpecification$WeightedCapacity' => 'The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. Capacity values represent performance characteristics such as vCPUs, memory, or I/O. If not specified, the default value is 1.
', 'OnDemandResizingSpecification$TimeoutDurationMinutes' => 'On-Demand resize timeout in minutes. If On-Demand Instances are not provisioned within this time, the resize workflow stops. The minimum value is 5 minutes, and the maximum value is 10,080 minutes (7 days). The timeout applies to all resize workflows on the Instance Fleet. The resize could be triggered by Amazon EMR Managed Scaling or by the customer (via Amazon EMR Console, Amazon EMR CLI modify-instance-fleet or Amazon EMR SDK ModifyInstanceFleet API) or by Amazon EMR due to Amazon EC2 Spot Reclamation.
', 'SpotProvisioningSpecification$TimeoutDurationMinutes' => 'The Spot provisioning timeout period in minutes. If Spot Instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.
The defined duration for Spot Instances (also known as Spot blocks) in minutes. When specified, the Spot Instance does not terminate before the defined duration expires, and defined duration pricing for Spot Instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot Instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates.
Spot Instances with a defined duration (also known as Spot blocks) are no longer available to new customers from July 1, 2021. For customers who have previously used the feature, we will continue to support Spot Instances with a defined duration until December 31, 2022.
Spot resize timeout in minutes. If Spot Instances are not provisioned within this time, the resize workflow will stop provisioning of Spot instances. Minimum value is 5 minutes and maximum value is 10,080 minutes (7 days). The timeout applies to all resize workflows on the Instance Fleet. The resize could be triggered by Amazon EMR Managed Scaling or by the customer (via Amazon EMR Console, Amazon EMR CLI modify-instance-fleet or Amazon EMR SDK ModifyInstanceFleet API) or by Amazon EMR due to Amazon EC2 Spot Reclamation.
', ], ], 'XmlString' => [ 'base' => NULL, 'refs' => [ 'Cluster$SecurityConfiguration' => 'The name of the security configuration applied to the cluster.
', 'Cluster$AutoScalingRole' => '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.
The name of the security configuration.
', 'CreateSecurityConfigurationOutput$Name' => 'The name of the security configuration.
', 'CreateStudioInput$ServiceRole' => 'The IAM role that the Amazon EMR Studio assumes. The service role provides a way for Amazon EMR Studio to interoperate with other Amazon Web Services services.
', 'CreateStudioInput$UserRole' => 'The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a UserRole when you use IAM Identity Center authentication. The permissions attached to the UserRole can be scoped down for each user or group using session policies.
The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
', 'CreateStudioInput$IdpAuthUrl' => 'The authentication endpoint of your identity provider (IdP). Specify this value when you use IAM authentication and want to let federated users log in to a Studio with the Studio URL and credentials from your IdP. Amazon EMR Studio redirects users to this endpoint to enter credentials.
', 'CreateStudioOutput$Url' => 'The unique Studio access URL.
', 'DeleteSecurityConfigurationInput$Name' => 'The name of the security configuration.
', 'DescribeSecurityConfigurationInput$Name' => 'The name of the security configuration.
', 'DescribeSecurityConfigurationOutput$Name' => 'The name of the security configuration.
', 'EnvironmentVariablesMap$value' => NULL, 'HadoopJarStepConfig$Jar' => 'A path to a JAR file run during the step.
', 'HadoopJarStepConfig$MainClass' => 'The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file.
', 'InstanceGroupDetail$LastStateChangeReason' => 'Details regarding the state of the instance group.
', 'JobFlowDetail$LogUri' => 'The location in Amazon S3 where log files for the job are stored.
', 'JobFlowDetail$LogEncryptionKmsKeyId' => 'The KMS key used for encrypting log files. This attribute is only available with Amazon EMR 5.30.0 and later, excluding 6.0.0.
', 'JobFlowDetail$JobFlowRole' => 'The IAM role that was specified when the job flow was launched. The Amazon EC2 instances of the job flow assume this role.
', 'JobFlowDetail$ServiceRole' => 'The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.
', 'JobFlowDetail$AutoScalingRole' => 'An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides a way for the automatic scaling feature to get the required permissions it needs to launch and terminate Amazon EC2 instances in an instance group.
Description of the job flow last changed state.
', 'JobFlowInstancesDetail$MasterPublicDnsName' => 'The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.
', 'JobFlowInstancesDetail$MasterInstanceId' => 'The Amazon EC2 instance identifier of the master node.
', 'KeyValue$Key' => 'The unique identifier of a key-value pair.
', 'KeyValue$Value' => 'The value part of the identified key.
', 'ListNotebookExecutionsInput$ExecutionEngineId' => 'The unique ID of the execution engine.
', 'NotebookExecution$NotebookParams' => 'Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
', 'NotebookExecution$OutputNotebookURI' => 'The location of the notebook execution\'s output file in Amazon S3.
', 'NotebookExecution$LastStateChangeReason' => 'The reason for the latest status change of the notebook execution.
', 'NotebookExecutionSummary$ExecutionEngineId' => 'The unique ID of the execution engine for the notebook execution.
', 'PlacementType$AvailabilityZone' => 'The Amazon EC2 Availability Zone for the cluster. AvailabilityZone is used for uniform instance groups, while AvailabilityZones (plural) is used for instance fleets.
The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.
', 'RunJobFlowInput$LogEncryptionKmsKeyId' => '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.
', 'RunJobFlowInput$AdditionalInfo' => 'A JSON string for selecting additional features.
', 'RunJobFlowInput$JobFlowRole' => '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.
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.
', 'RunJobFlowInput$SecurityConfiguration' => 'The name of a security configuration to apply to the cluster.
', 'RunJobFlowInput$AutoScalingRole' => '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.
Location in Amazon S3 of the script to run during a bootstrap action.
', 'SecurityConfigurationSummary$Name' => 'The name of the security configuration.
', 'StartNotebookExecutionInput$RelativePath' => '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.
Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
', 'StartNotebookExecutionInput$ServiceRole' => '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.
', 'StepExecutionStatusDetail$LastStateChangeReason' => 'A description of the step\'s current state.
', 'Studio$ServiceRole' => 'The name of the IAM role assumed by the Amazon EMR Studio.
', 'Studio$UserRole' => 'The name of the IAM role assumed by users logged in to the Amazon EMR Studio. A Studio only requires a UserRole when you use IAM authentication.
The unique access URL of the Amazon EMR Studio.
', 'Studio$DefaultS3Location' => 'The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
', 'Studio$IdpAuthUrl' => 'Your identity provider\'s authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.
', 'UpdateStudioInput$DefaultS3Location' => 'The Amazon S3 location to back up Workspaces and notebook files for the Amazon EMR Studio.
', 'XmlStringList$member' => NULL, ], ], 'XmlStringList' => [ 'base' => NULL, 'refs' => [ 'DescribeJobFlowsInput$JobFlowIds' => 'Return only job flows whose job flow ID is contained in this list.
', 'HadoopJarStepConfig$Args' => 'A list of command line arguments passed to the JAR file\'s main function when executed.
', 'ListStepsInput$StepIds' => 'The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten Step IDs. The character constraint applies to the overall length of the array.
', 'ScriptBootstrapActionConfig$Args' => 'A list of command line arguments to pass to the bootstrap action script.
', 'SetTerminationProtectionInput$JobFlowIds' => 'A list of strings that uniquely identify the clusters to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .
', 'SetVisibleToAllUsersInput$JobFlowIds' => 'The unique identifier of the job flow (cluster).
', 'SupportedProductConfig$Args' => 'The list of user-supplied arguments.
', 'TerminateJobFlowsInput$JobFlowIds' => 'A list of job flows to be shut down.
', ], ], 'XmlStringMaxLen256' => [ 'base' => NULL, 'refs' => [ 'AddInstanceFleetInput$ClusterId' => 'The unique identifier of the cluster.
', 'AddInstanceFleetOutput$ClusterId' => 'The unique identifier of the cluster.
', 'AddInstanceGroupsInput$JobFlowId' => 'Job flow in which to add the instance groups.
', 'AddInstanceGroupsOutput$JobFlowId' => 'The job flow ID in which the instance groups are added.
', 'AddJobFlowStepsInput$JobFlowId' => 'A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow and can also be obtained from ListClusters.
', 'BootstrapActionConfig$Name' => 'The name of the bootstrap action.
', 'CancelStepsInput$ClusterId' => 'The ClusterID for the specified steps that will be canceled. Use RunJobFlow and ListClusters to get ClusterIDs.
Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.
', 'CreateStudioInput$Name' => 'A descriptive name for the Amazon EMR Studio.
', 'CreateStudioInput$Description' => 'A detailed description of the Amazon EMR Studio.
', 'CreateStudioInput$VpcId' => 'The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
', 'CreateStudioInput$WorkspaceSecurityGroupId' => 'The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by VpcId.
The ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by VpcId.
The name that your identity provider (IdP) uses for its RelayState parameter. For example, RelayState or TargetSource. Specify this value when you use IAM authentication and want to let federated users log in to a Studio using the Studio URL. The RelayState parameter differs by IdP.
The ID of the Amazon EMR Studio.
', 'CreateStudioSessionMappingInput$StudioId' => 'The ID of the Amazon EMR Studio to which the user or group will be mapped.
', 'CreateStudioSessionMappingInput$IdentityId' => 'The globally unique identifier (GUID) of the user or group from the IAM Identity Center Identity Store. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either IdentityName or IdentityId must be specified, but not both.
The name of the user or group. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference. Either IdentityName or IdentityId must be specified, but not both.
The Amazon Resource Name (ARN) for the session policy that will be applied to the user or group. You should specify the ARN for the session policy that you want to apply, not the ARN of your user role. For more information, see Create an Amazon EMR Studio User Role with Session Policies.
', 'DeleteStudioInput$StudioId' => 'The ID of the Amazon EMR Studio.
', 'DeleteStudioSessionMappingInput$StudioId' => 'The ID of the Amazon EMR Studio.
', 'DeleteStudioSessionMappingInput$IdentityId' => 'The globally unique identifier (GUID) of the user or group to remove from the Amazon EMR Studio. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either IdentityName or IdentityId must be specified.
The name of the user name or group to remove from the Amazon EMR Studio. For more information, see UserName and DisplayName in the IAM Identity Center Store API Reference. Either IdentityName or IdentityId must be specified.
The unique identifier of the notebook execution.
', 'DescribeStudioInput$StudioId' => 'The Amazon EMR Studio ID.
', 'EnvironmentVariablesMap$key' => NULL, 'ExecutionEngineConfig$Id' => 'The unique identifier of the execution engine. For an Amazon EMR cluster, this is the cluster ID.
', 'ExecutionEngineConfig$MasterInstanceSecurityGroupId' => '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.
', 'GetClusterSessionCredentialsInput$ClusterId' => 'The unique identifier of the cluster.
', 'GetStudioSessionMappingInput$StudioId' => 'The ID of the Amazon EMR Studio.
', 'GetStudioSessionMappingInput$IdentityId' => 'The globally unique identifier (GUID) of the user or group. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either IdentityName or IdentityId must be specified.
The name of the user or group to fetch. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference. Either IdentityName or IdentityId must be specified.
A friendly name for the instance fleet.
', 'InstanceFleetConfig$Name' => 'The friendly name of the instance fleet.
', 'InstanceGroup$CustomAmiId' => 'The custom AMI ID to use for the provisioned instance group.
', 'InstanceGroupConfig$Name' => 'Friendly name given to the instance group.
', 'InstanceGroupConfig$BidPrice' => 'If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice to set the amount equal to the On-Demand price, or specify an amount in USD.
The custom AMI ID to use for the provisioned instance group.
', 'InstanceGroupDetail$InstanceGroupId' => 'Unique identifier for the instance group.
', 'InstanceGroupDetail$Name' => 'Friendly name for the instance group.
', 'InstanceGroupDetail$BidPrice' => 'If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice to set the amount equal to the On-Demand price, or specify an amount in USD.
The custom AMI ID to use for the provisioned instance group.
', 'InstanceGroupIdsList$member' => NULL, 'InstanceGroupModifyConfig$InstanceGroupId' => 'Unique ID of the instance group to modify.
', 'InstanceTypeConfig$BidPrice' => 'The bid price for each Amazon EC2 Spot Instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
The custom AMI ID to use for the instance type.
', 'InstanceTypeSpecification$BidPrice' => 'The bid price for each Amazon EC2 Spot Instance type as defined by InstanceType. Expressed in USD.
The custom AMI ID to use for the instance type.
', 'JobFlowDetail$JobFlowId' => 'The job flow identifier.
', 'JobFlowDetail$Name' => 'The name of the job flow.
', 'JobFlowDetail$AmiVersion' => '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.
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."
', 'JobFlowInstancesConfig$HadoopVersion' => '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.
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.
', 'JobFlowInstancesConfig$EmrManagedMasterSecurityGroup' => 'The identifier of the Amazon EC2 security group for the master node. If you specify EmrManagedMasterSecurityGroup, you must also specify EmrManagedSlaveSecurityGroup.
The identifier of the Amazon EC2 security group for the core and task nodes. If you specify EmrManagedSlaveSecurityGroup, you must also specify EmrManagedMasterSecurityGroup.
The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
', 'JobFlowInstancesDetail$Ec2KeyName' => 'The name of an Amazon EC2 key pair that can be used to connect to the master node using SSH.
', 'JobFlowInstancesDetail$Ec2SubnetId' => 'For clusters launched within Amazon Virtual Private Cloud, this is the identifier of the subnet where the cluster was launched.
', 'JobFlowInstancesDetail$HadoopVersion' => 'The Hadoop version for the cluster.
', 'KerberosAttributes$Realm' => 'The name of the Kerberos realm to which all nodes in a cluster belong. For example, EC2.INTERNAL.
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.
', 'KerberosAttributes$CrossRealmTrustPrincipalPassword' => '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.
', 'KerberosAttributes$ADDomainJoinUser' => 'Required only when establishing a cross-realm trust with an Active Directory domain. A user with sufficient privileges to join resources to the domain.
', 'KerberosAttributes$ADDomainJoinPassword' => 'The Active Directory password for ADDomainJoinUser.
The unique ID of the editor associated with the notebook execution.
', 'ListStudioSessionMappingsInput$StudioId' => 'The ID of the Amazon EMR Studio.
', 'NotebookExecution$NotebookExecutionId' => 'The unique identifier of a notebook execution.
', 'NotebookExecution$EditorId' => 'The unique identifier of the Amazon EMR Notebook that is used for the notebook execution.
', 'NotebookExecution$NotebookExecutionName' => 'A name for the notebook execution.
', 'NotebookExecution$Arn' => 'The Amazon Resource Name (ARN) of the notebook execution.
', 'NotebookExecution$NotebookInstanceSecurityGroupId' => 'The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide.
', 'NotebookExecutionSummary$NotebookExecutionId' => 'The unique identifier of the notebook execution.
', 'NotebookExecutionSummary$EditorId' => 'The unique identifier of the editor associated with the notebook execution.
', 'NotebookExecutionSummary$NotebookExecutionName' => 'The name of the notebook execution.
', 'NotebookS3LocationForOutput$Bucket' => 'The Amazon S3 bucket that stores the notebook execution input.
', 'NotebookS3LocationFromInput$Bucket' => 'The Amazon S3 bucket that stores the notebook execution input.
', 'OnDemandCapacityReservationOptions$CapacityReservationResourceGroupArn' => 'The ARN of the Capacity Reservation resource group in which to run the instance.
', 'OutputNotebookS3LocationForOutput$Bucket' => 'The Amazon S3 bucket that stores the notebook execution output.
', 'OutputNotebookS3LocationFromInput$Bucket' => 'The Amazon S3 bucket that stores the notebook execution output.
', 'RunJobFlowInput$Name' => 'The name of the job flow.
', 'RunJobFlowInput$AmiVersion' => '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.
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.
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.
', 'RunJobFlowInput$OSReleaseLabel' => '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.
', 'RunJobFlowOutput$JobFlowId' => 'A unique identifier for the job flow.
', 'SecurityGroupsList$member' => NULL, 'SessionMappingDetail$StudioId' => 'The ID of the Amazon EMR Studio.
', 'SessionMappingDetail$IdentityId' => 'The globally unique identifier (GUID) of the user or group.
', 'SessionMappingDetail$IdentityName' => 'The name of the user or group. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference.
', 'SessionMappingDetail$SessionPolicyArn' => 'The Amazon Resource Name (ARN) of the session policy associated with the user or group.
', 'SessionMappingSummary$StudioId' => 'The ID of the Amazon EMR Studio.
', 'SessionMappingSummary$IdentityId' => 'The globally unique identifier (GUID) of the user or group from the IAM Identity Center Identity Store.
', 'SessionMappingSummary$IdentityName' => 'The name of the user or group. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference.
', 'SessionMappingSummary$SessionPolicyArn' => 'The Amazon Resource Name (ARN) of the session policy associated with the user or group.
', 'StartNotebookExecutionInput$EditorId' => 'The unique identifier of the Amazon EMR Notebook to use for notebook execution.
', 'StartNotebookExecutionInput$NotebookExecutionName' => 'An optional name for the notebook execution.
', 'StartNotebookExecutionInput$NotebookInstanceSecurityGroupId' => 'The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.
', 'StartNotebookExecutionOutput$NotebookExecutionId' => 'The unique identifier of the notebook execution.
', 'StepConfig$Name' => 'The name of the step.
', 'StepIdsList$member' => NULL, 'StopNotebookExecutionInput$NotebookExecutionId' => 'The unique identifier of the notebook execution.
', 'Studio$StudioId' => 'The ID of the Amazon EMR Studio.
', 'Studio$StudioArn' => 'The Amazon Resource Name (ARN) of the Amazon EMR Studio.
', 'Studio$Name' => 'The name of the Amazon EMR Studio.
', 'Studio$Description' => 'The detailed description of the Amazon EMR Studio.
', 'Studio$VpcId' => 'The ID of the VPC associated with the Amazon EMR Studio.
', 'Studio$WorkspaceSecurityGroupId' => 'The ID of the Workspace security group associated with the Amazon EMR Studio. The Workspace security group allows outbound network traffic to resources in the Engine security group and to the internet.
', 'Studio$EngineSecurityGroupId' => 'The ID of the Engine security group associated with the Amazon EMR Studio. The Engine security group allows inbound network traffic from resources in the Workspace security group.
', 'Studio$IdpRelayStateParameterName' => 'The name of your identity provider\'s RelayState parameter.
The ID of the Amazon EMR Studio.
', 'StudioSummary$Name' => 'The name of the Amazon EMR Studio.
', 'StudioSummary$VpcId' => 'The ID of the Virtual Private Cloud (Amazon VPC) associated with the Amazon EMR Studio.
', 'StudioSummary$Description' => 'The detailed description of the Amazon EMR Studio.
', 'StudioSummary$Url' => 'The unique access URL of the Amazon EMR Studio.
', 'SupportedProductConfig$Name' => 'The name of the product configuration.
', 'SupportedProductsList$member' => NULL, 'UpdateStudioInput$StudioId' => 'The ID of the Amazon EMR Studio to update.
', 'UpdateStudioInput$Name' => 'A descriptive name for the Amazon EMR Studio.
', 'UpdateStudioInput$Description' => 'A detailed description to assign to the Amazon EMR Studio.
', 'UpdateStudioSessionMappingInput$StudioId' => 'The ID of the Amazon EMR Studio.
', 'UpdateStudioSessionMappingInput$IdentityId' => 'The globally unique identifier (GUID) of the user or group. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either IdentityName or IdentityId must be specified.
The name of the user or group to update. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference. Either IdentityName or IdentityId must be specified.
The Amazon Resource Name (ARN) of the session policy to associate with the specified user or group.
', 'UsernamePassword$Username' => 'The username associated with the temporary credentials that you use to connect to cluster endpoints.
', 'UsernamePassword$Password' => 'The password associated with the temporary credentials that you use to connect to cluster endpoints.
', 'XmlStringMaxLen256List$member' => NULL, ], ], 'XmlStringMaxLen256List' => [ 'base' => NULL, 'refs' => [ 'Ec2InstanceAttributes$RequestedEc2SubnetIds' => 'Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch Amazon EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the Amazon EC2 subnet with the best fit from among the list of RequestedEc2SubnetIds, and then launches all cluster instances within that Subnet. If this value is not specified, and the account and Region support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses RequestedEc2AvailabilityZones instead of this setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.
Applies to clusters configured with the instance fleets option. Specifies one or more Availability Zones in which to launch Amazon EC2 cluster instances when the EC2-Classic network configuration is supported. Amazon EMR chooses the Availability Zone with the best fit from among the list of RequestedEc2AvailabilityZones, and then launches all cluster instances within that Availability Zone. If you do not specify this value, Amazon EMR chooses the Availability Zone for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.
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.
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.